Cvent Event Cloud RFP Suppliers API

openapi: 3.2.0
info:
  title: Cvent REST RFP Suppliers API
  description: "# 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: RFP Suppliers
  description: Suppliers are the venues and service providers that receive and respond to RFPs. Use these APIs to manage supplier associations, view recipient history, and create award details.
paths:
  /rfps/{rfpId}/recipients/history:
    get:
      tags:
      - RFP Suppliers
      summary: List RFP Recipients History
      description: Returns the paginated list of logs of all the recipients that were copied on an RFP.
      operationId: listRfpRecipientsHistory
      security:
      - OAuth2.clientCredentials:
        - rfp/rfp-recipients-history:read
      - OAuth2.authorizationCode:
        - rfp/rfp-recipients-history:read
      parameters:
      - $ref: '#/components/parameters/rfpId'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        description: 'A filter query string narrows search results and supports the combination of logical and comparison operators.

          The filter adheres to the pattern filter=''field'' comparisonType ''value''.


          These are the comparison operators that can be used in filter expressions:

          * includes value(s): in


          The following fields are filterable:

          * supplier.id (in)

          '
        schema:
          type: string
          example: supplier.id in ('37f2de41-6f50-484a-a55d-3cf0ede2ebac')
      responses:
        '200':
          description: Successfully retrieved the paginated list of logs of all the recipients that were copied on an RFP.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRfpRecipientsHistory'
        '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'
  /rfps/{rfpId}/suppliers:
    get:
      tags:
      - RFP Suppliers
      summary: List RFP Suppliers
      description: Returns the paginated list of suppliers associated with an RFP.
      operationId: getRfpSuppliers
      security:
      - OAuth2.clientCredentials:
        - rfp/rfp-suppliers:read
      - OAuth2.authorizationCode:
        - rfp/rfp-suppliers:read
      parameters:
      - $ref: '#/components/parameters/rfpId'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - name: filter
        in: query
        description: 'A filter query string narrows search results and supports the combination of logical and comparison operators.

          The filter adheres to the pattern filter=''field'' comparisonType ''value''.


          These are the comparison operators that can be used in filter expressions:

          * includes value(s): in


          The following fields are filterable:

          * supplier.id (in)

          '
        schema:
          type: string
          example: supplier.id in ('37f2de41-6f50-484a-a55d-3cf0ede2ebac')
      - $ref: '#/components/parameters/leadSourceExpand'
      responses:
        '200':
          description: Successfully retrieved the paginated list of suppliers associated with an RFP.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRfpSuppliers'
        '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'
components:
  schemas:
    PaginatedRfpSuppliers:
      title: PaginatedRfpSuppliers
      description: Paginated response containing suppliers associated with an RFP.
      type: object
      required:
      - paging
      - data
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        data:
          type: array
          items:
            $ref: '#/components/schemas/RfpSupplier'
          description: List of RFP suppliers.
    SupplierId:
      title: SupplierId
      type: string
      format: uuid
      description: The unique identifier of a supplier.
      example: 50dc08af-24a9-4d01-84be-3d43133dc945
    TargetType:
      title: TargetType
      description: The target type can either refer to the type of recipient or the type of action that made the recipient a participant in the RFP process.
      type: string
      enum:
      - ASSIGNEE
      - BILLING_CONTACT
      - FORWARDING_NSO
      - FORWARDING_SUPPLIER
      - HYATT_ENVISION
      - IN_PROGRESS
      - MARRIOTT_SIEBEL
      - MEETING_BROKER
      - OPERA
      - PLANNER
      - PRIVATE_NSO
      - PROPOSAL_CC
      - PROPOSAL
      - PUBLIC_NSO
      - RECEIPT_CONFIRMED
      - RFP_CC_RECIPIENT
      - SUPPLIER
      - TURN_DOWN
      example: PUBLIC_NSO
    SupplierAssociatedAds:
      title: SupplierAssociatedAds
      description: Ads clicked by planner while adding supplier on RFP.
      type: object
      properties:
        firstClicked:
          type: object
          allOf:
          - description: First advertisement for the supplier which planner clicked.
          - $ref: '#/components/schemas/SupplierAd'
        lastClicked:
          type: object
          allOf:
          - description: Last advertisement for the supplier which planner clicked.
          - $ref: '#/components/schemas/SupplierAd'
    RfpSupplierStatus:
      title: RfpSupplierStatus
      description: The RFP's current status with respect to the supplier.
      type: string
      enum:
      - AWAITING_PROPOSAL
      - AWARDED
      - CANCELLED
      - DECLINED
      - FORWARDED
      - NO_RESPONSE
      - NOT_SENT
      - RECEIPT_CONFIRMED
      - SUBMITTED_PROPOSAL
      - TURNED_DOWN
      - WITHDRAWN
      example: AWAITING_PROPOSAL
    PaginatedRfpRecipientsHistory:
      title: PaginatedRfpRecipientsHistory
      description: Paginated response containing logs of all the recipients that were copied on an RFP.
      type: object
      required:
      - paging
      - data
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        data:
          type: array
          items:
            $ref: '#/components/schemas/RfpRecipientLogEntry'
          description: List of RFP recipient logs.
    RfpSupplier:
      type: object
      title: RfpSupplier
      description: Supplier data for an RFP.
      allOf:
      - $ref: '#/components/schemas/Audit'
      properties:
        supplier:
          type: object
          description: The supplier associated with the RFP.
          allOf:
          - $ref: '#/components/schemas/ReferenceToSupplier'
          readOnly: true
        rfp:
          type: object
          allOf:
          - $ref: '#/components/schemas/ReferenceToRFP'
          readOnly: true
        externalSupplier:
          type: object
          description: External supplier associated with the RFP. If planners cannot find a supplier in Cvent, they can add the supplier by providing the name when awarding the RFP.
          properties:
            name:
              type: string
              maxLength: 100
              description: The name of the external supplier.
              example: ABC Corp
          readOnly: true
        associatedAdvertisements:
          type: object
          allOf:
          - $ref: '#/components/schemas/SupplierAssociatedAds'
          readOnly: true
        proposalInProgress:
          type: boolean
          description: True indicates that proposal creation is in progress by supplier.
          example: true
          readOnly: true
        internalNote:
          type: string
          description: Internal note by planner for supplier. This is not visible to the supplier.
          maxLength: 300
          example: Don't award this RFP to the same venue as last year.
          readOnly: true
        leadSource:
          type: object
          allOf:
          - $ref: '#/components/schemas/LeadSource'
        largestMeetingRoomMet:
          type: boolean
          description: True indicates the largest meeting room criteria is met.
          example: true
          readOnly: true
        numberOfGuestRoomsMet:
          type: boolean
          description: True indicates the number of guest rooms criteria is met.
          example: true
          readOnly: true
        totalMeetingSpaceMet:
          type: boolean
          description: True indicates the total meeting space criteria is met.
          example: true
          readOnly: true
        promotion:
          type: object
          description: Promotion applied by planner while adding supplier on RFP.
          properties:
            id:
              type: string
              format: uuid
              description: The unique identifier of the promotion.
              example: 41cc09ag-61a0-5e21-942e-2d41232dc923
        recommendationNote:
          type: string
          maxLength: 300
          description: Recommendations added by planner for supplier.
          example: The staff should be courteous.
          readOnly: true
        shortlistOrder:
          type: integer
          description: Shortlisted order for the supplier.
          maximum: 50
          example: 45
          readOnly: true
        showcase:
          type: boolean
          description: True indicates the supplier was added by using RFP showcase feature.
          example: true
          readOnly: true
        starred:
          type: boolean
          description: True indicates the RFP is starred by supplier. This is not visible to the planner.
          example: false
          readOnly: true
        status:
          type: string
          allOf:
          - $ref: '#/components/schemas/RfpSupplierStatus'
          readOnly: true
        statusChangedDateTime:
          type: string
          format: date-time
          description: The ISO 8601 date time (in UTC) when the status was last changed.
          example: '2017-01-02T02:59:59.999Z'
          readOnly: true
        responder:
          type: string
          description: Name of the recipient associated with supplier who responded to the RFP.
          maxLength: 80
          example: John Doe
          readOnly: true
        response:
          type: object
          allOf:
          - $ref: '#/components/schemas/SupplierResponse'
          readOnly: true
        externalProposalId:
          type: string
          maxLength: 50
          description: Unique identifier for proposal created by supplier in the external system where it originated.
          example: '143227'
          readOnly: true
        externalId:
          type: string
          maxLength: 50
          description: Unique identifier for RFP in the external system where it originated.
          example: '234123'
          readOnly: true
        forwardId:
          type: string
          format: uuid
          description: The unique identifier generated when supplier forwards the RFP to other suppliers.
          example: d024cc04-adf1-443c-854a-97ab9f5a14b2
          readOnly: true
        lastSentDateTime:
          type: string
          format: date-time
          description: The ISO 8601 date time (in UTC) when the RFP was last sent to the supplier.
          example: '2017-01-02T02:59:59.999Z'
          readOnly: true
        lastViewedDateTime:
          type: string
          format: date-time
          description: The ISO 8601 date time (in UTC) when the RFP was last viewed by the supplier.
          example: '2017-01-02T02:59:59.999Z'
          readOnly: true
        sentDateTime:
          type: string
          format: date-time
          description: The ISO 8601 date time (in UTC) when the RFP was originally sent to the supplier.
          example: '2017-01-02T02:59:59.999Z'
          readOnly: true
        sentToNso:
          type: boolean
          description: True indicates the RFP was sent to NSO (National Sales Office) associated with supplier.
          example: false
          readOnly: true
    RFPID:
      title: RFP ID
      description: A unique identifier for an RFP
      type: string
      format: uuid
      example: a0f3116a-4dd8-4923-b778-188cbe00a68f
    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.
    LeadSource:
      title: LeadSource
      description: Lead source details.
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for source generating the RFP. Details about this lead source can be fetched using <a href="#tag/RFP-Management/operation/getRfpLeadSource">lead source API.</a>
          example: 50dc08af-24a9-4d01-84be-3d43133dc945
        section:
          $ref: '#/components/schemas/LeadSourceSection'
    SupplierAd:
      title: SupplierAd
      description: Supplier Advertisement.
      type: object
      properties:
        code:
          type: string
          maxLength: 30
          description: Unique code generated for the supplier advertisement.
          example: RXBMLPSP
    LeadSourceSection:
      title: LeadSourceSection
      description: Represents lead source section details, which is a sub area of source generating the RFP.
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for sub area of source generating the RFP. Details about this lead source section can be fetched using <a href="#tag/RFP-Management/operation/getRfpLeadSourceSection">lead source section API.</a>
          example: 40dc08af-24a9-4d01-84be-3d43133dc945
    RfpResponseReason:
      title: RfpResponseReason
      description: Reason given for a response to an RFP.
      type: string
      enum:
      - BOOKED_ANOTHER_VENUE_OR_DESTINATION
      - CLIENT_BOOKED_DIRECTLY
      - COMPETITOR_CONTRACT_AGREEMENT
      - DATES_OR_PATTERN
      - DECISION_DATE_PASSED
      - DID_NOT_MEET_REQUIREMENTS
      - EPIDEMIC_OR_PANDEMIC
      - EVENT_CANCELLED
      - EVENT_POSTPONED
      - FOOD_AND_BEVERAGE_MINIMUM_TOO_HIGH
      - FOOD_AND_BEVERAGE_TOO_LOW
      - INCOMPLETE_RFP
      - LATE_RESPONSE
      - LOW_BUDGET
      - MEDICAL_EMERGENCY
      - MEETING_ROOM_RENTAL_TOO_HIGH
      - MEETING_SPACE_CEILING_HEIGHT
      - MEETING_SPACE_NO_LONGER_AVAILABLE
      - MEETING_SPACE_UNAVAILABLE
      - NATURAL_DISASTER
      - NO_FOOD_AND_BEVERAGE
      - OTHER
      - POLITICAL_OR_CIVIL_UNREST
      - PREFERRED_OR_ALTERNATE_DATES_UNAVAILABLE
      - PROPERTY_AMENITIES_OR_SERVICES
      - PROPERTY_LOCATION
      - RENOVATIONS
      - REQUESTED_ROOM_RATE_TOO_LOW
      - REQUIREMENTS_CHANGED
      - ROOMS_TO_SPACE_RATIO
      - SELECTED_OTHER_CITY
      - SELECTED_OTHER_HOTEL_OR_VENUE
      - SIZE_OF_MEETING_SPACE
      - GUEST_ROOM_RATE_TOO_HIGH
      - GUEST_ROOMS_NO_LONGER_AVAILABLE
      - GUEST_ROOMS_UNAVAILABLE
      - SUITE_AVAILABILITY
      - TOO_SPACE_INTENSIVE
      - VENUE_PERMANENTLY_CLOSED
      - VENUE_TEMPORARILY_CLOSED
      - VENUE_TOO_SMALL
      example: GUEST_ROOMS_NO_LONGER_AVAILABLE
    Paging:
      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/PaginationLinks'
    Link:
      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
    Audit:
      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
    ReferenceToSupplier:
      type: object
      title: Reference to Supplier
      description: Reference to a supplier by its ID.
      required:
      - id
      properties:
        id:
          $ref: '#/components/schemas/SupplierId'
    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
    ReferenceToRFP:
      type: object
      title: Reference to RFP
      description: Reference to an RFP (Request For Proposal) by its ID.
      required:
      - id
      properties:
        id:
          $ref: '#/components/schemas/RFPID'
    PaginationLinks:
      title: PaginationLinks
      type: object
      description: Represents pagination links for navigating between pages of data.
      properties:
        next:
          $ref: '#/components/schemas/Link'
        self:
          $ref: '#/components/schemas/Link'
        prev:
          $ref: '#/components/schemas/Link'
    SupplierResponse:
      title: SupplierResponse
      description: Contains response from supplier on an RFP.
      type: object
      properties:
        dateTime:
          type: string
          format: date-time
          description: The ISO 8601 date time (in UTC) when the response was sent by supplier.
          example: '2017-02-02T03:19:19.991Z'
        reason:
          $ref: '#/components/schemas/RfpResponseReason'
        comment:
          type: string
          description: Comment for the response reason.
          maxLength: 2500
          example: We are unable to accommodate the request on the required dates. Please let us know if we can help with any other dates.
    RfpRecipientLogEntry:
      type: object
      title: RfpRecipientLogEntry
      description: Contains the log entry when the recipient was copied on an RFP.
      properties:
        supplier:
          type: object
          description: The supplier associated with the recipient.
          properties:
            id:
              type: string
              format: uuid
              description: The unique identifier of the supplier.
              example: d024cc04-adf1-443c-854a-97ab9f5a14b2
        recipientIdentifier:
          type: string
          maxLength: 80
          description: This can either be the email address or the code of the recipient. This will not be present if the target type is MEETING_BROKER
          example: jwest@example.com
        active:
          type: boolean
          description: True indicates that the recipient is active for receiving emails.
          example: true
        addedByNso:
          type: boolean
          description: True indicates that the recipient was added by the National Sales Office.
          example: false
        targetType:
          $ref: '#/components/schemas/TargetType'
        sendDateTime:
          type: string
          format: date-time
          description: The ISO 8601 send date and time in UTC.
          example: '2024-08-20T00:00:01Z'
        message:
          type: object
          description: Message for the recipient.
          properties:
            id:
              type: string
              format: uuid
              description: The unique identifier of the message.
              example: a1c776ab-51ee-44a7-8720-b3dfc44d689b
  parameters:
    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
    leadSourceExpand:
      name: expand
      in: query
      explode: false
      required: false
      description: "This endpoint allows you to request additional information as an expanded response using the expand query parameter. The expanded entity is retrieved and displayed inline for each specified expand value.\n\nAn object contains the ID of a related object in its response properties. You 

# --- 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-rfp-suppliers-api-openapi.yml