openapi: 3.0.2
info:
title: Cvent REST APIs — RFP Suppliers
version: ea
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.
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: 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:
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
SupplierAd:
title: SupplierAd
description: Supplier Advertisement.
type: object
properties:
code:
type: string
maxLength: 30
description: Unique code generated for the supplier advertisement.
example: RXBMLPSP
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
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
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
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
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.
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
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
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.
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'
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
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
lead source API.
example: 50dc08af-24a9-4d01-84be-3d43133dc945
section:
$ref: '#/components/schemas/LeadSourceSection'
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 lead source section API.
example: 40dc08af-24a9-4d01-84be-3d43133dc945
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'
RFPID:
title: RFP ID
description: A unique identifier for an RFP
type: string
format: uuid
example: a0f3116a-4dd8-4923-b778-188cbe00a68f
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'
ReferenceToSupplier:
type: object
title: Reference to Supplier
description: Reference to a supplier by its ID.
required:
- id
properties:
id:
$ref: '#/components/schemas/SupplierId'
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'
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
ErrorResponse-12:
title: ErrorResponse
description: Represents an error response with additional details of cascading error messages.
allOf:
- $ref: '#/components/schemas/ErrorResponseBase1'
type: object
required:
- code
- message
properties:
details:
type: array
items:
$ref: '#/components/schemas/ErrorResponseBase1'
description: Additional details of cascading error messages.
responses:
NotFound1:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse-12'
example:
code: 404
message: Not found
BadRequest1:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse-12'
example:
code: 400
message: Bad Request
TooManyRequests1:
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse-12'
example:
code: 429
message: Limit Exceeded
Unauthorized1:
description: Bad or expired token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse-12'
example:
code: 401
message: Unauthorized
Forbidden1:
description: You do not have access to the resource
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse-12'
example:
code: 403
message: Access Forbidden
parameters:
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 can expand these objects in-line using the expand query\
\ parameter.\n\nYou can expand multiple objects at the same time by identifying multiple items in the expand array.\n\
\nThe respective scopes for each expansion are required.\n\nThe following fields are expandable:\n * leadSource\n\
\ * **Scope**: rfp/rfp-lead-sources:read\n * **Reference**: Get RFP Lead Source\n * leadSource.section\n * **Scope**: rfp/rfp-lead-sources:read\n * **Reference**:\
\ Get RFP Lead Source Section\n"
example:
- leadSource
- leadSource.section
schema:
type: array
items:
type: string
enum:
- leadSource
- leadSource.section
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
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
rfpId:
name: rfpId
description: The unique identifier of the RFP we are requesting
style: simple
in: path
required: true
schema:
type: string
format: uuid
example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
securitySchemes:
OAuth2.clientCredentials:
type: oauth2
description: OAuth2 Client Credentials Flow.
flows:
clientCredentials:
tokenUrl: https://api-platform.cvent.com/ea/oauth2/token
scopes:
account/hooks:delete: Allows the deletion of hooks.
account/hooks:read: Allows the reading of hooks.
account/hooks:write: Allows the creation/updation of hooks.
account/user-groups:delete: Allows deletion for user groups
account/user-groups:read: Allows the reading of user groups
account/user-groups:write: Allows the writing of user groups
account/users:delete: Allows the deletion of User
account/users:read: Allows the reading of User, User Group
account/users:write: Allows the creation/updating of User
appointments/appointment-attendees:read: Allows the reading of appointment attendees and their related entities.
appointments/appointment-events:read: Allows the reading of appointment events and their related entities.
appointments/appointment-types:read: Allows the reading of appointment types and their related entities.
appointments/appointments:read: Allows the reading of appointment and their related entities.
appointments/appointments:write: Allows the writing of appointments and their related entities.
appointments/available-times:read: Allows the reading of availability times.
appointments/locations:read: Allows the reading of appointment locations and their related entities.
attendee-insights/attendee-insights:read: Allows the reading of engagement scores (attendee insights).
attendee-insights/scores:read: Allows the reading of scores.
attendee-insights/stats:read: Allows the reading of engagement score (attendee insight) stats.
budget/budget-items:delete: Allows the deletion of budget items
budget/budget-items:read: Allows the reading of all budget items
budget/budget-items:write: Allows creation/updation of budget item
budget/budget-totals:read: Allows the reading of all event budget totals
budget/budget-vendors:read: Allows reading of account-level budget vendors.
budget/cards:read: Allows the reading of cards
budget/currency-conversion-rate:delete: Allows deletion of currency conversion rate for currency.
budget/currency-conversion-rate:read: Allows reading of currency conversion rate for currency.
budget/currency-conversion-rate:write: Allows creation/update of currency conversion rate for currency.
budget/payments:delete: Allows deletion of payments.
budget/payments:read: Allows reading of payment for budget item.
budget/payments:write: Allows creation of payment in a budget item.
budget/transactions:delete: Allows delete card transactions.
budget/transactions:read: Allows the reading of all card's transactions
budget/transactions:write: Allows creation of card transactions.
bulk/bulk-jobs:read: Allows the reading of bulk job related entities
bulk/bulk-jobs:write: Allows the creation, update and deletion of bulk job related entities
business-transient/bids:read: Allows the reading of Business Transient Bid data
business-transient/proposals:read: Allows the reading of Business Transient Proposal data
business-transient/supplier-brands:read: Allows the reading of a supplier brand or a list of travel supplier brands.
business-transient/supplier-chains:read: Allows the reading of a travel supplier chain or a list of travel supplier
chains.
business-transient/supplier-properties:read: Allows the reading of a travel supplier property or a list of travel
supplier properties.
business-transient/supplier-property-rooms:read: Allows the reading of a list of travel supplier property rooms.
business-transient/travel-accounts:read: Allows the reading of business transient travel account data.
business-transient/travel-program-questions:read: Allows the reading of business transient travel program question
data.
business-transient/travel-programs:read: Allows the reading of business transient travel program data.
business-transient/travel-supplier-accounts:read: Allows the reading of business transient travel supplier account
data.
business-travel/bids:read: Allows the reading of Business Travel Bid data
business-travel/proposals:read: Allows the reading of Business Travel Proposal data
business-travel/travel-accounts:read: Allows the reading of business travel account data.
business-travel/travel-program-questions:read: Allows the reading of business travel program question data.
business-travel/travel-programs:read: Allows the reading of business travel program data.
compliance/communications:read: Allows the reading of communication compliance
compliance/communications:write: Allows the writing of communication compliance
email/bounces:read: Allow the reading of email bounces.
email/email-status:read: Allows the reading of email statuses.
email/emails:read: Allows the reading of emails.
eMarketing/campaigns:read: Allows the reading of campaigns.
emarketing/emarketing-email-status:read: Allows the reading of eMarketing email statuses.
eMarketing/eMarketing-email-templates:read: Allows the reading of email-templates.
eMarketing/eMarketing-send-emails:write: Allows the writing of eMarketing emails.
event/admission-items:read: Allows the reading of admission items
event/air-request:read: Allow reading the air request or air actual detail for attendees.
event/alternate-travel:read: Allow reading the alternate travel answers for attendees.
event/attendance-durations:read: Allows the read of Duration records
event/attendee-activities-metadata:delete: Allows the deletion of attendees activities metadata.
event/attendee-activities-metadata:read: Allows the reading of attendee activities metadata.
event/attendee-activities-metadata:write: Allows the creation/updating of attendees activities metadata.
event/attendee-activities:read: Allows the reading of attendee activities.
event/attendee-activities:write: Allows the writing of external attendee activities.
event/attendee-credits:read: Allows the reading of attendee credits.
event/attendee-links:delete: Allows the deletion of attendee links
event/attendee-links:read: Allows the reading of attendee links
event/attendee-links:write: Allows the creation of attendee links
event/attendee-messages:read: Allows the reading of attendee messages
event/attendees:read: Allows the reading of attendees.
event/attendees:write: Allows the creation of an attendee in an event.
event/audience-segments:read: Allows the reading of audience segments.
event/audience-segments:write: Allows the creation/updating/deletion of audience segments.
event/contact-groups:read: Allows the reading of contact groups.
event/contact-groups:write: Allows the creation/updating of contact groups.
event/contact-types:read: Allows the reading of contact types.
event/contacts:delete: Allows the deletion of contacts.
event/contacts:read: Allows the reading of contacts.
event/contacts:write: Allows the creation/updating of contacts.
event/contacts:write-sensitive: Allows the creation/updating of sensitive data related to contacts.
event/custom-fields:read: Allows the reading of custom fields
event/custom-fields:write: Allows the writing of custom fields
event/discounts:write: Allows the writing of discounts
event/donation-items:read: Allows the reading of donation items.
event/event-discounts:read: Allows the reading of event discounts.
event/event-discounts:write: Allows the writing of event discounts.
event/event-email-status:read: Allows the reading of event email statuses.
event/event-emails:read: Allows the reading of event emails
event/event-emails:write: Allows to send event emails.
event/event-features:read: Allows the reading of events-features
event/event-features:write: Allows updating the event-features
event/event-user-groups:read: Allows the reading of user groups
event/event-user-groups:write: Allows associating/disassociating user groups to event
event/events:read: Allows the reading of events
event/events:write: Allows the creation/updating of events
event/fee-items:read: Allows the reading of fee items.
event/hotel-request:read: Allow reading the hotel request or housing reservation request detail for attendees.
event/invitation-lists:read: Allows the reading of the invitation lists for an event
event/meeting-request-forms:read: Allows the reading of meeting request forms.
event/meeting-requests:read: Allows the reading of meeting requests.
event/meeting-requests:write: Allows the creation/updating of meeting requests.
event/membership-items:read: Allows reading of membership items.
event/orders:read: Allows the reading of orders
event/planning-documents:read: Allows the reading of event planning documents
event/players:read: Allows the reading of players
event/process-form-submissions:read: Allows the reading of process form submissions.
event/program-items:delete: Allows deletion of session program items
event/program-items:read: Allows reading of session program items
event/program-items:write: Allows writing of session program items
event/quantity-items:read: Allows the reading of quantity items.
event/quantity-items:write: Allows the writing of quantity items
event/registration-paths:read: Allows the reading of registration paths
event/registration-types:read: Allows the reading of registration types
event/registration-types:write: Allows the writing of registration types
event/role-assignments:read: Allows the reading of event role assignment.
event/session-attendance:read: Allows the reading of sessions attendance
event/session-attendance:write: Allows the creation/updating of sessions attendance
event/session-categories:read: Allows reading of session categories
event/session-categories:write: Allows writing of session categories
event/session-enrollment:delete: Allows the deletion of session registrations
event/session-enrollment:read: Allows the reading of sessions registrations
event/session-enrollment:write: Allows the writing of sessions registrations
event/session-segments:read: Allows reading of session segments
event/sessions:delete: Allows the deletion of a session in an event
event/sessions:read: Allows the reading of sessions
event/sessions:write: Allows the creation of a session in an event
event/speaker-categories:read: Allows reading of speaker categories
event/speaker-categories:write: Allows writing of speaker categories
event/speakers:delete: Allows the deletion of a speaker in an event
event/speakers:read: Allows the reading of speakers
event/speakers:write: Allows the creation of a speaker in an event
event/taxes:read: Allows the reading of taxes.
event/transactions:read: Allows the reading of transactions
event/transactions:write: Allows the writing of transactions
event/video-views:read: Allows reading of video views.
event/videos:read: Allows the reading of video data.
event/videos:write: Allows the creation/updating of video data.
event/vouchers:read: Allows reading of event vouchers.
event/webcasts:delete: Allows the deletion of webcast
event/webcasts:read: Allows the reading of webcasts
event/webcasts:write: Allows the creation of webcast
event/weblinks:read: Allows the reading of event weblinks
events-plus/hubs:read: Allows the reading of Events+ hub data.
exhibitor/badges:read: Allows reading badges
exhibitor/badges:write: Allows creating/updating badges
exhibitor/booth-staff:delete: Allows deleting booth staff
exhibitor/booth-staff:read: Allows reading booth staff
exhibitor/booth-staff:write: Allows creating booth staff
exhibitor/eliterature-requests:read: Allows reading eliterature document request data
exhibitor/exhibitor-admins:read: Allows reading exhibitor admins
exhibitor/exhibitor-admins:write: Allows creating/updating exhibitor admins
exhibitor/exhibitor-answers:read: Allows reading exhibitor answers
exhibitor/exhibitor-answers:write: Allows updating exhibitor answers
exhibitor/exhibitor-categories:delete: Allows deleting exhibitor categories
exhibitor/exhibitor-categories:read: Allows reading exhibitor categories
exhibitor/exhibitor-categories:write: Allows creating/updating exhibitor categories
exhibitor/exhibitor-contents:delete: Allows deleting exhibitor content
exhibitor/exhibitor-contents:read: Allows reading exhibitor content
exhibitor/exhibitor-contents:write: Allows creating/updating exhibitor content
exhibitor/exhibitor-questions:read: Allows reading exhibitor questions
exhibitor/exhibitors:delete: Allows deleting exhibitors
exhibitor/exhibitors:read: Allows reading exhibitors
exhibitor/exhibitors:write: Allows creating/updating exhibitors
exhibitor/lead-qualification-answers:read: Allows reading Lead Qualification Answers
exhibitor/lead-qualification-questions:read: Allows reading Lead Qualification Questions.
exhibitor/leads:read: Allows reading leads.
exhibitor/registration-packs:delete: Allows deleting registration pack
exhibitor/registration-packs:read: Allows reading registration pack
exhibitor/registration-packs:write: Allows creating/updating registration pack
exhibitor/sponsorship-levels:read: Allows reading sponsorship level
file/file:read: Allows the reading of file
file/file:write: Allows the uploading of file
housing/connections:write: Allows the user to connect to the Reglink APIs.
housing/hotel-room-rates:write: Allows the user to create/update hotel room rates.
housing/housing-event-available-nights:read: Allows the user to read availability information for given event.
housing/housing-event-hotels:read: Allows the user to read information about event hotels.
housing/housing-event-inventory:read: Allows the user to get information about housing event inventory.
housing/housing-event-room-types:read: Allows the user to read information about event room types.
housing/housing-events:read: Allows the user to read information about events.
housing/reservation-requests:delete: Allows the user to cancel reservation request.
housing/reservation-requests:read: Allows the user to read reservation request information.
housing/reservation-requests:write: Allows the user to create/update reservation request.
housing/reservations-link:delete: Allows the user to remove association from reservation.
housing/reservations-link:write: Allows the user to associate reservation to reservation request.
housing/reservations:delete: Allows the user to cancel reservation.
housing/reservations:read: Allows the user to read reservation details information.
housing/reservations:write: Allows the user to create/update reservation.
onsite/signatures:read: Allows reading signatures.
proposal/proposals:write: Allows the creation/writing of proposal
remote-printing/badge-print-jobs:read: Allows reading print jobs.
remote-printing/badge-print-jobs:write: Allows creating print jobs.
remote-printing/badge-printer-pools:read: Allows reading pools.
rfp/rfp-agenda-items:read: Allows the reading of RFP agenda items.
rfp/rfp-attachments:read: Allows the reading of RFP attachments.
rfp/rfp-custom-fields:read: Allows the reading of RFP custom fields.
rfp/rfp-guest-rooms:read: Allows the reading of RFP guest rooms.
rfp/rfp-internal-documents:read: Allows the reading of RFP internal documents.
rfp/rfp-lead-sources:read: Allows the reading of RFP lead sources.
rfp/rfp-past-events:read: Allows the reading of past events similar to rfp event.
rfp/rfp-questions:read: Allows the reading of RFP questions.
rfp/rfp-recipients-history:read: Allows the reading of RFP recipients history.
rfp/rfp-suppliers:read: Allows the reading of RFP suppliers.
rfp/rfps:read: Allows the reading of basic details of RFP.
seating/assignments:read: Allows to read attendee seat assignment information.
seating/event-seatings:read: Allows to read event seating.
seating/seats:read: Allows to read seat information.
seating/tables:read: Allows to read table information.
secure-ecommerce/card-tokens:write: Allows creation of credit card tokens
survey/questions:read: Allows the reading of survey questions
survey/respondents:read: Allows reading the survey respondents
survey/responses:read: Allows reading the survey responses
survey/standard-survey-email-templates:read: Allows reading the standalone survey email templates
survey/standard-survey-email:write: Allows writing operations on standalone survey emails
survey/standard-survey-questions:read: Allows the reading of standalone surveys questions
survey/standard-survey-respondents:read: Allows reading the standalone survey respondents
survey/standard-survey-respondents:write: Allows write operations on standalone survey respondents
survey/standard-survey-responses:read: Allows reading the standalone survey responses
survey/standard-survey-responses:write: Allows write operations on standalone surveys respondent's responses
survey/standard-surveys:read: Allows the reading of standalone surveys
survey/survey-questions:read: Allows the reading of event survey questions
survey/survey-respondents:read: Allows reading the event survey respondents
survey/survey-respondents:write: Allows write operations on the event survey respondents
survey/survey-responses:read: Allows reading the event survey responses
survey/survey-responses:write: Allows write operations on the event surveys respondent's responses
survey/surveys:read: Allows the reading of event surveys
venue/meeting-room-images:delete: Allows disassociating images from meeting rooms.
venue/meeting-room-images:read: Allows retrieving meeting room images.
venue/meeting-room-images:write: Allows associating images with meeting rooms.
venue/meeting-room-overviews:read: Allows read access for overview of meeting room.
venue/meeting-rooms:write: Allows the creation and modification of meeting rooms.
venue/venue-details-overview:read: Allows read access for overview of venue details.
venue/venue-details:write: Allows the creation and modification of venue details.
venue/venue-facility:write: Allows the modification of venue facility information.
OAuth2.authorizationCode:
type: oauth2
description: OAuth2 Authorization Code Flow.
flows:
authorizationCode:
authorizationUrl: https://api-platform.cvent.com/ea/oauth2/authorize
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 available times.
appointments/locations:read: Allows the reading of appointment locations and their related entities.
attendee-insights/attendee-insights:read: Allows the reading of engagement scores (attendee insights).
attendee-insights/scores:read: Allows the reading of scores.
attendee-insights/stats:read: Allows the reading of engagement score (attendee insight) stats.
budget/budget-items:delete: Allows the deletion of budget items
budget/budget-items:read: Allows the reading of all budget items
budget/budget-items:write: Allows creation/updation of budget item
budget/budget-totals:read: Allows the reading of all event budget totals
budget/budget-vendors:read: Allows reading of account-level budget vendors.
budget/cards:read: Allows the reading of cards
budget/currency-conversion-rate:delete: Allows deletion of currency conversion rate for currency.
budget/currency-conversion-rate:read: Allows reading of currency conversion rate for currency.
budget/currency-conversion-rate:write: Allows creation/update of currency conversion rate for currency.
budget/payments:delete: Allows deletion of payments.
budget/payments:read: Allows reading of payment for budget item.
budget/payments:write: Allows creation of payment in a budget item.
budget/transactions:delete: Allows delete card transactions.
budget/transactions:read: Allows the reading of all card's transactions
budget/transactions:write: Allows creation of card transactions.
business-transient/bids:read: Allows the reading of BT Bid data
business-transient/proposals:read: Allows the reading of BT Proposal data
business-travel/bids:read: Allows the reading of BT Bid data
business-travel/proposals:read: Allows the reading of BT Proposal data
compliance/communications:read: Allows the reading of communication compliance
compliance/communications:write: Allows the writing of communication compliance
email/bounces:read: Allow the reading of email bounces.
email/email-status:read: Allows the reading of email statuses.
email/emails:read: Allows the reading of emails.
eMarketing/campaigns:read: Allows the reading of campaigns.
emarketing/emarketing-email-status:read: Allows the reading of eMarketing email statuses.
eMarketing/eMarketing-email-templates:read: Allows the reading of email-templates.
eMarketing/eMarketing-send-emails:write: Allows the writing of eMarketing emails.
event/admission-items:read: Allows the reading of admission items
event/air-request:read: Allow reading the air request or air actual detail for attendees.
event/alternate-travel:read: Allow reading the alternate travel answers for attendees.
event/attendance-durations:read: Allows the read of Duration records
event/attendee-activities-metadata:delete: Allows the deletion of attendees activities metadata.
event/attendee-activities-metadata:read: Allows the reading of attendee activities metadata.
event/attendee-activities-metadata:write: Allows the creation/updating of attendees activities metadata.
event/attendee-activities:read: Allows the reading of attendee activities.
event/attendee-activities:write: Allows the writing of attendee activities.
event/attendee-credits:read: Allows the reading of attendee credits.
event/attendee-links:delete: Allows the deletion of attendee links
event/attendee-links:read: Allows the reading of attendee links
event/attendee-links:write: Allows the creation of attendee links
event/attendee-messages:read: Allows the reading of attendee messages
event/attendees:read: Allows the reading of attendees.
event/attendees:write: Allows the creation of an attendee in an event.
event/audience-segments:read: Allows the reading of audience segments.
event/audience-segments:write: Allows the creation/updating/deletion of audience segments.
event/contact-groups:read: Allows the reading of contact groups.
event/contact-groups:write: Allows the creation/updating of contact groups.
event/contact-types:read: Allows the reading of contact types.
event/contacts:delete: Allows the deletion of contacts.
event/contacts:read: Allows the reading of contacts.
event/contacts:write: Allows the creation/updating of contacts.
event/contacts:write-sensitive: Allows the creation/updating of sensitive data related to contacts.
event/custom-fields:read: Allows the reading of custom fields
event/custom-fields:write: Allows the writing of custom fields
event/discounts:write: Allows the writing of discounts
event/donation-items:read: Allows the reading of donation items.
event/event-discounts:read: Allows the reading of event discounts.
event/event-discounts:write: Allows the writing of event discounts.
event/event-email-status:read: Allows the reading of event email statuses.
event/event-emails:read: Allows the reading of event emails
event/event-emails:write: Allows to send event emails.
event/event-features:read: Allows the reading of events-features
event/event-features:write: Allows updating the event-features
event/event-user-groups:read: Allows the reading of user groups
event/event-user-groups:write: Allows associating/disassociating user groups to event
event/events:read: Allows the reading of events
event/events:write: Allows the creation/updating of events
event/fee-items:read: Allows the reading of fee items.
event/hotel-request:read: Allow reading the hotel request or housing reservation request detail for attendees.
event/invitation-lists:read: Allows the reading of the invitation lists for an event
event/meeting-request-forms:read: Allows the reading of meeting request forms.
event/meeting-requests:read: Allows the reading of meeting requests.
event/meeting-requests:write: Allows the creation/updating of meeting requests.
event/membership-items:read: Allows reading of membership items.
event/orders:read: Allows the reading of orders
event/planning-documents:read: Allows the reading of event planning documents
event/players:read: Allows the reading of players
event/process-form-submissions:read: Allows the reading of process form submissions.
event/program-items:delete: Allows deletion of session program items
event/program-items:read: Allows reading of session program items
event/program-items:write: Allows writing of session program items
event/quantity-items:read: Allows the reading of quantity items.
event/quantity-items:write: Allows the writing of quantity items
event/registration-paths:read: Allows the reading of registration paths
event/registration-types:read: Allows the reading of registration types
event/registration-types:write: Allows the writing of registration types
event/role-assignments:read: Allows the reading of event role assignment.
event/session-attendance:read: Allows the reading of sessions attendance
event/session-attendance:write: Allows the creation/updating of sessions attendance
event/session-categories:read: Allows reading of session categories
event/session-categories:write: Allows writing of session categories
event/session-enrollment:delete: Allows the deletion of session registrations
event/session-enrollment:read: Allows the reading of sessions registrations
event/session-enrollment:write: Allows the writing of sessions registrations
event/session-segments:read: Allows reading of session segments
event/sessions:delete: Allows the deletion of a session in an event
event/sessions:read: Allows the reading of sessions
event/sessions:write: Allows the creation of a session in an event
event/speaker-categories:read: Allows reading of speaker categories
event/speaker-categories:write: Allows writing of speaker categories
event/speakers:delete: Allows the deletion of a speaker in an event
event/speakers:read: Allows the reading of speakers
event/speakers:write: Allows the creation of a speaker in an event
event/taxes:read: Allows the reading of taxes.
event/transactions:read: Allows the reading of transactions
event/transactions:write: Allows the writing of transactions
event/video-views:read: Allows reading of video views.
event/videos:read: Allows the reading of video data.
event/videos:write: Allows the creation/updating of video data.
event/vouchers:read: Allows reading of event vouchers and their associated attendees.
event/webcasts:delete: Allows the deletion of webcast
event/webcasts:read: Allows the reading of webcasts
event/webcasts:write: Allows the creation of webcast
event/weblinks:read: Allows the reading of event weblinks
events-plus/hubs:read: Allows the reading of Events+ hub data.
exhibitor/badges:read: Allows reading badges
exhibitor/badges:write: Allows creating/updating badges
exhibitor/booth-staff:delete: Allows deleting booth staff
exhibitor/booth-staff:read: Allows reading booth staff
exhibitor/booth-staff:write: Allows creating booth staff
exhibitor/eliterature-requests:read: Allows reading eliterature document request data
exhibitor/exhibitor-admins:read: Allows reading exhibitor admins
exhibitor/exhibitor-admins:write: Allows creating/updating exhibitor admins
exhibitor/exhibitor-answers:read: Allows reading exhibitor answers
exhibitor/exhibitor-answers:write: Allows updating exhibitor answers
exhibitor/exhibitor-categories:delete: Allows deleting exhibitor categories
exhibitor/exhibitor-categories:read: Allows reading exhibitor categories
exhibitor/exhibitor-categories:write: Allows creating/updating exhibitor categories
exhibitor/exhibitor-contents:delete: Allows deleting exhibitor content
exhibitor/exhibitor-contents:read: Allows reading exhibitor content
exhibitor/exhibitor-contents:write: Allows creating/updating exhibitor content
exhibitor/exhibitor-questions:read: Allows reading exhibitor questions
exhibitor/exhibitors:delete: Allows deleting exhibitors
exhibitor/exhibitors:read: Allows reading exhibitors
exhibitor/exhibitors:write: Allows creating/updating exhibitors
exhibitor/lead-qualification-answers:read: Allows reading Lead Qualification Answers
exhibitor/lead-qualification-questions:read: Allows reading Lead Qualification Questions.
exhibitor/leads:read: Allows reading leads.
exhibitor/registration-packs:delete: Allows deleting registration pack
exhibitor/registration-packs:read: Allows reading registration pack
exhibitor/registration-packs:write: Allows creating/updating registration pack
exhibitor/sponsorship-levels:read: Allows reading sponsorship level
file/file:read: Allows the reading of file
file/file:write: Allows the uploading of file
onsite/signatures:read: Allows reading signatures.
remote-printing/badge-print-jobs:read: Allows reading print jobs.
remote-printing/badge-print-jobs:write: Allows creating print jobs.
remote-printing/badge-printer-pools:read: Allows reading pools.
rfp/rfp-agenda-items:read: Allows the reading of RFP agenda items.
rfp/rfp-attachments:read: Allows the reading of RFP attachments.
rfp/rfp-custom-fields:read: Allows the reading of RFP custom fields.
rfp/rfp-guest-rooms:read: Allows the reading of RFP guest rooms.
rfp/rfp-internal-documents:read: Allows the reading of RFP internal documents.
rfp/rfp-lead-sources:read: Allows the reading of RFP lead sources.
rfp/rfp-past-events:read: Allows the reading of past events similar to rfp event.
rfp/rfp-questions:read: Allows the reading of RFP questions.
rfp/rfp-recipients-history:read: Allows the reading of RFP recipients history.
rfp/rfp-suppliers:read: Allows the reading of RFP suppliers.
rfp/rfps:read: Allows the reading of basic details of RFP.
seating/assignments:read: Allows to read attendee seat assignment information.
seating/event-seatings:read: Allows to read event seating.
seating/seats:read: Allows to read seat information.
seating/tables:read: Allows to read table information.
survey/questions:read: Allows the reading of survey questions
survey/respondents:read: Allows reading the survey respondents
survey/responses:read: Allows reading the survey responses
survey/standard-survey-email-templates:read: Allows reading the standalone survey email templates
survey/standard-survey-email:write: Allows writing operations on standalone survey emails
survey/standard-survey-questions:read: Allows the reading of standalone surveys questions
survey/standard-survey-respondents:read: Allows reading the standalone survey respondents
survey/standard-survey-respondents:write: Allows write operations on standalone survey respondents
survey/standard-survey-responses:read: Allows reading the standalone survey responses
survey/standard-survey-responses:write: Allows write operations on standalone surveys respondent's responses
survey/standard-surveys:read: Allows the reading of standalone surveys
survey/survey-questions:read: Allows the reading of event survey questions
survey/survey-respondents:read: Allows reading the event survey respondents
survey/survey-respondents:write: Allows write operations on the event survey respondents
survey/survey-responses:read: Allows reading the event survey responses
survey/survey-responses:write: Allows write operations on the event surveys respondent's responses
survey/surveys:read: Allows the reading of event surveys
venue/meeting-room-images:delete: Allows disassociating images from meeting rooms.
venue/meeting-room-images:read: Allows retrieving meeting room images.
venue/meeting-room-images:write: Allows associating images with meeting rooms.
venue/meeting-room-overviews:read: Allows read access for overview of meeting room.
venue/meeting-rooms:write: Allows the creation and modification of meeting rooms.
venue/venue-details-overview:read: Allows read access for overview of venue details.
venue/venue-details:write: Allows the creation and modification of venue details.
venue/venue-facility:write: Allows the modification of venue facility information.