Cvent Event Cloud Event Features API

EventFeatures related APIs

OpenAPI Specification

cvent-event-cloud-event-features-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cvent REST APIs — Event Cloud Event Features API
  description: "Event Cloud scope of the Cvent REST APIs. This document is a TAG-SCOPED SUBSET of the OpenAPI specification Cvent publishes at https://github.com/cvent/rest-sdks/blob/main/cvent-public-spec/openapi.yaml (the source of truth for Cvent's official TypeScript/.NET/Java SDKs). Venue-sourcing, RFP, housing-supplier and travel-supplier tags were removed because they belong to Cvent Hospitality Cloud; every path, operation, parameter, schema and security requirement below is verbatim from Cvent's published spec.\n\n# Introduction\nThe Cvent API Platform is built around REST. We aim to provide intuitive endpoints that can be easily\ndiscovered to help leverage the Cvent platform for your event needs. The RESTful APIs outlined here\nuse JSON-encoded request and response format, along with HTTP codes, to convey processing status of\nrequests received. The Cvent resources are protected using OAuth2.\n\n# Getting Started\n\nIf you're new to the Cvent API Platform, start by reading our\n[Developer Quickstart](https://developers.cvent.com/docs/rest-api/tutorials/developer-quickstart) guide. This will\ngive you an overview of how to authenticate and make requests using our APIs.\n\n## Authentication\n\nThe Cvent REST API uses [OAuth2](https://oauth.net/2/) to authorize requests to the platform. The client\ncredentials authorization flow is supported.\n\n<a name=\"oauth2-auth-code-planner-admin\"></a>\n\nAuthorization code flow is only supported for planner users with the administrator role in Cvent. Developer users\ncannot use authorization code flow.\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\nHere's an example of using client credential flow to authorize. You'll supply your application's id and secret to\nmake a [Token](#operation/oauth2Token) request.\n\n```bash\ncurl --location --request POST '{hostName}/{version}/oauth2/token' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--header 'Authorization: Basic {api_credentials}' \\\n--data-urlencode 'grant_type=client_credentials' \\\n--data-urlencode 'client_id={client_id}'\n```\n\n| Key               | Description                                          | Value                                                                                                        |\n| :---------------- | :--------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- |\n| {hostName}        | https://api-platform.cvent.com                       | Location if your account is in the North American datacenter.                                                |\n|                   | https://api-platform-eur.cvent.com                   | Location if your account is in the European data center.                                                     |\n| {version}         | ea                                                   | The version of the API you're using. Only `ea` is currently supported.                                       |\n| {api_credentials} | {client_id}:{client_secret} in base64 encoded format | Supply your client id & client credentials in a base 64 encoded format.                                      |\n| {client_id}       | Retrieved from your application                      | Your application's client id.                                                                                |\n| {client_secret}   | Retrieved from your application                      | Your application's client secret.                                                                            |\n\nOn a successful call, you'll receive the following response:\n\n```json\n{\n  \"access_token\": \"{accessToken}\",\n  \"expires_in\": 3600,\n  \"token_type\": \"Bearer\"\n}\n```\n\nThis bearer token is valid for 3600 seconds (60 minutes) and must be used in subsequent calls.\n\n## Endpoints\n\nEndpoints start with `hostName` and `version`.\n\nThe `hostname` will depend on the region that your Cvent account is hosted in. Please see the table\nbelow to identify which hostname you should be using.\n\n| Region        |\tHostname                           |\n|:--------------|:-----------------------------------|\n| North America\t| https://api-platform.cvent.com     |\n| Europe        | https://api-platform-eur.cvent.com |\n\nThe current `version` of the Cvent API is `ea`.\n\n## Rate Limits\n\nCvent APIs enforce rate limits to ensure platform stability. Your limits depend on your tier: Free,\nStandard, or Premium.\n\n<br />\n\n### Usage Tiers\n\n| Tier     | Daily Calls | Calls per Second | Max Burst |\n| -------- | ----------- | ---------------- | --------- |\n| Free     | 1,000       | 2                | 1         |\n| Standard | 15,000      | 10               | 10        |\n| Premium  | 500,000     | 25               | 25        |\n\n- **Daily calls** define how many requests you can make in a 24-hour period. Quota\n  resets at 12 midnight (+0 GMT).\n- **Calls per second** define how many requests you can make in a 1-second window.\n- **Max Burst** defines how many requests you can make at once.\n\nIf you are unsure what usage tier applies to your account, you can check via\n[Get Current Usage Tier](#operation/getUsageTier).\n\nPlease note that these limits may change as the Cvent API Platform evolves.\n\n<br />\n\n### Handling Rate Limits\n\nSometimes, you may exceed your rate limits. When this happens, the API will return a `429 Too Many Requests`. See\n[handling rate limits](https://developers.cvent.com/docs/rest-api/guides/handling-rate-limits) for best practices on how to handle this.\n\n## Pagination\n\nSome APIs use pagination to manage records. Each page of records has a token associated to identify it.\n\nIf an API uses pagination, you’ll find up to three tokens in the response:\n- **currentToken**: Describes the token of the current page.\n- **nextToken**: Provides a token for the next page of records, if one exists.\n- **previousToken**: Provides a token for the previous page of records, if one exists. Not all APIs will return\n  this token.\n\nYou specify which page of records to view via the `token` parameter in your API call. To navigate through pages,\ntake the `nextToken` or `previousToken` value and pass it to your next call’s `token` parameter to get the\nrespective page of records. For example, if you made this request:\n\n```bash\ncurl -X GET {hostname}/{version}/contacts?limit=100 \\\n-H 'Accept: application/json' \\\n-H 'Authorization: Bearer {accessToken}'\n```\n\nThe response contains a paging array where you'll find the token information.\n\n```json\n{\n  \"paging\": {\n    \"currentToken\": \"90c5f062-76ad-4ea4-aa53-00eb698d9262\",\n    \"nextToken\": \"3b2359a7-4583-40ed-8afd-67e5f15373d3\",\n    \"limit\": 100,\n    \"totalCount\": 102,\n    \"_links\": {...}\n  },\n  \"data\": [...]\n}\n```\n\nTake the `nextToken` and use it in the `token` parameter on your subsequent call.\n\n```bash\ncurl -X GET {hostname}/{version}/contacts?limit=100&token=3b2359a7-4583-40ed-8afd-67e5f15373d3 \\\n-H 'Accept: application/json' \\\n-H 'Authorization: Bearer {accessToken}'\n```\n\nWhen the response doesn’t contain a `nextToken` field, you’ve reached the last page. Occasionally, you might\nencounter an empty page at the end of results. This typically happens when the results were evenly divisible.\nEnsure your client code handles the possibility of receiving an empty data array when using the `nextToken`.\n\n## Filtering\n\nUse filters to narrow down results. The filter follows the pattern\n`filter='field' comparisonType 'value'`. The value can be enclosed with single\nquotes (') or double quotes (\").\n\n```bash\nGET {hostName}/{version}/contacts?filter=lastName eq 'Smith'\n````\n\nTo correctly pass a single quote in the filter's value, use double quotes around\nthe string.\n\n```bash\nGET {hostName}/{version}/contacts?filter=lastName eq \"O'Keenan\"\n```\n\nTo correctly pass a double quote in the filter's value, use double quotes around\nthe string and add an escape character `\\` to each quote that is part of the\nstring.\n\n```bash\nGET {hostName}/{version}/events?filter=eventName eq \"\\\"Yearly\\\" Conference\"\n```\n\n## Versioning\n\nChange is inevitable in API development. Planning for it is crucial. We track\nboth backward-compatible and backward-incompatible changes.\n\n<br />\n\n### Backward Compatible Changes\n\nBackward compatible changes will be made often and are intended to avoid\nany adverse impact on our customers. It is highly advisable that when reading\nJSON payloads from Cvent, you are able to handle \"unknown\" attributes that\ncan be added over time. We consider the following changes backward-compatible:\n\n- Adding new resources\n- Adding new optional request parameters to existing operations\n- Adding new attributes to requests or responses\n- Changing the length or format (not type) of resource identifiers. For example, an ID can change from\n  \"1234/1234\" to \"1234::1234\".\n- Increasing the length of string fields\n\n<br />\n\n### Backward Incompatible Changes\n\nBackward-incompatible changes are made infrequently, however, they can be\ndisruptive to consumers. Due to this, our APIs are versioned to avoid\ndisruptions to customers. We leverage a URI-based versioning scheme,\nwhich means that a version value is included in the Cvent API URL.\nWhen breaking changes occur, a new version of the API is made available\nwhile the existing version is deprecated but remains available for a\nlimited period of time. We consider the following backward-incompatible changes:\n\n- Adding a new required parameter (query string param or payload attribute)\n- Deleting API resources\n- Deleting any attribute from API responses\n- Changing the data type on any parameter or attribute\n\n## Standards\nAs you begin working with our APIs, it's essential to be aware of standards around\ncountry codes, time formats, and other important details that ensure smooth integration.\nLearn more about our [API Standards](https://developers.cvent.com/docs/rest-api/reference/api-standards)\n"
  contact:
    name: Cvent Development Platform
    url: https://developers.cvent.com/
  version: ea
servers:
- url: https://api-platform.cvent.com/ea
- url: https://api-platform-eur.cvent.com/ea
tags:
- name: Event Features
  description: EventFeatures related APIs
paths:
  /events/{id}/features:
    parameters:
    - $ref: '#/components/parameters/id10'
    get:
      security:
      - OAuth2.clientCredentials:
        - event/event-features:read
      - OAuth2.authorizationCode:
        - event/event-features:read
      summary: List Event Features
      operationId: getEventFeatures
      description: A resource responsible for providing the set of event features that are available for an event
      tags:
      - Event Features
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - $ref: '#/components/parameters/locale1'
      - name: filter
        in: query
        required: false
        description: 'Use filter query parameters to limit results

          to data that matches your criteria. See

          [Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.


          Supported fields and operators are listed below:


          | Field   | Operators |

          |---------|-----------|

          | enabled | `eq`      |

          '
        schema:
          type: string
          example: enabled eq 'true'
      responses:
        '200':
          description: Successfully retrieved event features
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event-features-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'
  /events/{id}/features/{type}:
    parameters:
    - $ref: '#/components/parameters/id10'
    - $ref: '#/components/parameters/type'
    put:
      security:
      - OAuth2.clientCredentials:
        - event/event-features:write
      - OAuth2.authorizationCode:
        - event/event-features:write
      summary: Update Event Feature
      operationId: updateEventFeatures
      description: A resource responsible to enable / disable an event feature
      tags:
      - Event Features
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/feature-update'
        required: true
      responses:
        '200':
          description: Successfully updated event features
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event-features-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'
  /events/{id}/features/{type}/launch:
    parameters:
    - $ref: '#/components/parameters/id10'
    - $ref: '#/components/parameters/launch-feature-type'
    post:
      security:
      - OAuth2.clientCredentials:
        - event/event-features:write
      - OAuth2.authorizationCode:
        - event/event-features:write
      summary: Launch Event Feature
      operationId: launchEventFeatures
      description: Launch event features to make them available to an audience.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/event-feature-launch-request'
      tags:
      - Event Features
      responses:
        '204':
          description: Successfully launched event feature.
        '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'
  /events/{id}/weblinks:
    parameters:
    - $ref: '#/components/parameters/id10'
    get:
      security:
      - OAuth2.clientCredentials:
        - event/weblinks:read
      - OAuth2.authorizationCode:
        - event/weblinks:read
      summary: List Event Weblinks
      description: Gets a paginated list of weblinks for the given event.
      operationId: listEventWeblinks
      tags:
      - Event Features
      parameters:
      - $ref: '#/components/parameters/token'
      - $ref: '#/components/parameters/locale1'
      - $ref: '#/components/parameters/limit-100'
      responses:
        '200':
          description: Successfully retrieved a paginated list of event weblinks.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event-weblinks-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'
components:
  schemas:
    event-features-response:
      title: EventFeature
      description: Representation of an event's feature along with its properties
      type: object
      required:
      - type
      - locked
      - enabled
      properties:
        type:
          $ref: '#/components/schemas/feature-type.json'
        enabled:
          type: boolean
          description: If a particular feature is enabled for the event
          example: true
        locked:
          type: boolean
          description: If a particular feature is locked to perform any mutation over it
          example: true
        lockedReason:
          type: string
          description: Generic message informing feature is locked due to some sub-feature/child feature in use
          example: Your event is already using some Registration features
        enabledTier:
          $ref: '#/components/schemas/tier.json'
        availableTiers:
          description: Available feature tiers.
          type: array
          items:
            $ref: '#/components/schemas/feature-tier.json'
        config:
          type: object
          description: Feature configuration.
          anyOf:
          - title: RegistrationFeatureConfig
            description: Denote the configuration for the registration feature.
            type: object
            properties:
              pricing:
                $ref: '#/components/schemas/pricing-config.json'
        weblink:
          type: string
          format: uri
          readOnly: true
          description: URL of the feature's webpage.
          example: https://cvent.me/XX51b9
    payment-method-type.json:
      title: PaymentMethodType
      type: string
      readOnly: true
      description: Denotes acceptable payment methods for merchant accounts. Not all options are valid for all merchants.
      enum:
      - AIRPLUS
      - American Express
      - Aurora
      - Aurore
      - Authorize.Net SIM
      - BCMC
      - Bank Transfer
      - Billy
      - CB
      - Cash
      - Check
      - Cofinoga
      - Corporate Card
      - Credit
      - CyberSource Hosted Order Page
      - CyberSource Secure Acceptance
      - Dankort
      - Diners Club
      - Direct Bill
      - Discover
      - Eurocard Mastercard
      - Invoice
      - JCB
      - Laser
      - Maestro
      - MaestroUK
      - Mastercard
      - Mastercard Debit
      - Money Order
      - NetReserve
      - Other
      - Other 2
      - Other 3
      - P-Card
      - PRIVILEGE
      - Pay.gov
      - PayPal
      - Payment Credits
      - Purchase Order
      - Solo
      - TouchNet
      - UATP
      - UnionPay
      - Visa
      - Visa Debit
      - Visa Electron
      - WPM
      example: Visa
    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
    feature-tier.json:
      title: FeatureTier
      description: Tier available for the feature
      type: object
      required:
      - name
      properties:
        name:
          $ref: '#/components/schemas/tier.json'
        locked:
          type: boolean
          description: If a particular tier is locked to perform any mutation over it
          example: false
        lockReason:
          type: string
          description: Generic message informing tier to be locked due to some feature in use
          example: ''
    event-feature.json:
      title: EventFeature
      description: Representation of an event's feature along with its properties
      type: object
      required:
      - type
      - locked
      - enabled
      properties:
        type:
          $ref: '#/components/schemas/feature-type.json'
        enabled:
          type: boolean
          description: If a particular feature is enabled for the event
          example: true
        locked:
          type: boolean
          description: If a particular feature is locked to perform any mutation over it
          example: true
        lockedReason:
          type: string
          description: Generic message informing feature is locked due to some sub-feature/child feature in use
          example: Your event is already using some Registration features
        enabledTier:
          $ref: '#/components/schemas/tier.json'
        availableTiers:
          description: Available feature tiers.
          type: array
          items:
            $ref: '#/components/schemas/feature-tier.json'
        config:
          type: object
          description: Feature configuration.
          anyOf:
          - $ref: '#/components/schemas/event-features-response/properties/config/anyOf/0'
        weblink:
          type: string
          format: uri
          readOnly: true
          description: URL of the feature's webpage.
          example: https://cvent.me/XX51b9
    feature-type.json:
      title: FeatureType
      description: 'The type of feature available for a container event.


        | Value | Description |

        |-------|-------------|

        | `Website` | Allows you to promote your event with a customizable series of pages. |

        | `Registration` | Allows attendees to sign up for your event ahead of time. Once done, they can modify their details or cancel altogether if you allow it. |

        | `OnArrival` | Adds several options designed to make supporting your live event as smooth as possible. |

        | `AttendeeHub` | Delivers the attendee-facing website and mobile app with agenda/content, engagement tools (live Q&A, polls, gamification), and networking—launchable independently of registration. |

        | `Appointments` | Enables attendees, exhibitors, and staff to schedule and manage 1:1 meetings within Attendee Hub. |

        | `Planning` | Adds new ways to stay organized behind the scenes throughout the entire event process. |

        | `Agenda` | Allows you to manage the breakouts, presentations, or activities (known in Cvent as sessions) that make up your event. |

        | `Travel` | Allows you to easily collect and manage invitees'' hotel and flight preferences. |

        | `Marketing` | Allows planners to create, personalize, and automate branded event emails (invites, reminders, confirmations) and track performance to drive registrations and engagement. |

        | `Surveys` | Adds a customizable questionnaire you can use to gather feedback. |

        | `Speakers` | Allows you to showcase and manage all the headliners, keynoters, presenters, and moderators contributing to your event. |

        | `Exhibitors` | Centralizes exhibitor setup—profiles, tasks, content/categories—and booth staff and LeadCapture management, with exhibitor listings and engagement surfaced in Attendee Hub. |

        | `Vendors` | Allows planners to source and manage event services directly from the container event. |

        | `EventAds` | Allows planners to create, place, and track targeted ads across Attendee Hub and the event app. |

        | `EventCredits` | Allows planners to set rules and track credits attendees earn for sessions and the event. Only one of `EventCredits` or `CreditsAndCertificates` can be active at a time. |

        | `CreditsAndCertificates` | Allows planners to create credit rules, link them to events and sessions, and award credits to attendees. Also enables creating certificates, linking them to credit rules, and awarding them to attendees. Only one of `EventCredits` or `CreditsAndCertificates` can be active at a time. |'
      type: string
      enum:
      - Website
      - Registration
      - OnArrival
      - AttendeeHub
      - Appointments
      - Planning
      - Agenda
      - Travel
      - Marketing
      - Surveys
      - Speakers
      - Exhibitors
      - Vendors
      - EventAds
      - EventCredits
      - CreditsAndCertificates
      example: Registration
    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'
    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
    feature-update:
      title: FeatureUpdate
      description: Representation of an event feature update request
      type: object
      required:
      - type
      - enabled
      properties:
        type:
          $ref: '#/components/schemas/feature-type.json'
        enabled:
          type: boolean
          description: If a particular feature is enabled for the event
          example: true
        enabledTier:
          $ref: '#/components/schemas/tier.json'
        config:
          type: object
          description: Feature configuration.
          anyOf:
          - $ref: '#/components/schemas/event-features-response/properties/config/anyOf/0'
    ErrorResponseBase:
      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
    ErrorResponse:
      title: ErrorResponse
      description: Represents an error response with additional details of cascading error messages.
      allOf:
      - $ref: '#/components/schemas/ErrorResponseBase'
      type: object
      required:
      - code
      - message
      properties:
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseBase'
          description: Additional details of cascading error messages.
    event-weblink.json:
      title: EventWeblink
      description: Metadata for an event weblink.
      type: object
      properties:
        name:
          type: string
          maxLength: 50
          description: Name of the weblink, used by planners to identify the weblinks in their event.
          example: VIP Registration
        url:
          type: string
          format: uri
          description: Short URL of the webpage.
          example: https://cvent.me/XX51b9
        landingPage:
          type: string
          description: The name of the webpage attendees will be directed to when using the weblink.
          example: Registration
        locale:
          $ref: '#/components/schemas/locale.json'
    event-features-paginated-response:
      title: EventFeaturesPaginatedResponse
      description: Paginated collection of event features.
      required:
      - data
      - paging
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/paging.json'
        data:
          type: array
          items:
            $ref: '#/components/schemas/event-feature.json'
          description: Collection of event features
    locale.json:
      title: Locale
      description: Locale code
      type: string
      example: en-US
      minLength: 1
      maxLength: 200
    launch-feature-type.json:
      title: LaunchFeatureType
      description: These are the types of features used in the event container events that can be launched.
      type: string
      enum:
      - Website
      - Registration
      example: Registration
    tier.json:
      title: tier
      description: Represents the type of license that the user can choose.
      type: string
      enum:
      - PRO
      - PREMIER
      - ESSENTIALS
      - BASIC
      - PREMIUM
      example: PREMIER
    event-feature-launch-request:
      title: EventFeaturesLaunchRequest
      description: Event-features launch request parameters.
      type: object
      properties:
        deleteTestData:
          description: True keeps email data collected in test mode, prior to the registration feature being launched.
          type: boolean
          default: false
    pricing-config.json:
      title: PricingConfig
      description: Represents the configuration of the event's pricing feature.
      type: object
      required:
      - enabled
      properties:
        enabled:
          type: boolean
          description: True enables pricing for the event.
          example: true
        invoicePrefix:
          type: string
          description: A prefix helps distinguish invoices for this event from those of other events.
          example: EVE001
          maxLength: 6
        revenueGoal:
          type: number
          description: Revenue goal for the event.
          example: 10000
        merchantAccount:
          type: string
          description: Name of the merchant account associated with the event. This merchant account is where all event payments are deposited and refunds are withdrawn.
          example: Event merchant account - USD
          default: ''
        currency:
          type: string
          description: The ISO 4217 standard format currency code representing the currency used for event pricing.
          maxLength: 3
          example: USD
        allowedPaymentMethods:
          type: array
          description: Names of allowed payment methods for the merchant account. Not all options are valid for all merchants.
          items:
            $ref: '#/components/schemas/payment-method-type.json'
          uniqueItems: true
          example:
          - Visa
          - Diners Club
          - Mastercard
    event-weblinks-paginated-response:
      title: EventWeblinksPaginatedResponse
      description: Paginated collection of event weblinks.
      required:
      - data
      - paging
      type: object
      properties:
        paging:
          type: object
          allOf:
          - properties:
              limit:
                description: The number of records to return on the page, not to exceed 100.
                example: 100
          - $ref: '#/components/schemas/paging.json'
        data:
          type: array
          items:
            $ref: '#/components/schemas/event-weblink.json'
          description: Collection of event weblinks.
    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'
  responses:
    NotFound1:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 404
            message: Not found
    TooManyRequests1:
      

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