Changelog
REST API Updates (November 14, 2024)#
Added
New Endpoints:
- List Budget Allocations. Gets a list of budget allocations for a specific event.
- List Events+ Hubs. Retrieves a list of Events+ hubs.
- Get Events+ Hub Members. Retrieves members of a specific Events+ hub.
New OAuth2 Scopes:
events-plus/hubs:read
: Allows the reading of Events+ hub data
New Tags:
- Events+ Hub
Updated
- Create Transactions: Added response for "Too many requests" (429).
- Create/Update/Delete Attendee Link: Added response for "Not found" (404).
- List Attendees: Description updates.
- POST LIST Attendees: Description updates.
REST API Updates (October 18, 2024)#
Added
- Get Tables changed:
- new query parameter
expand
- New expandable property
data.seats
- new query parameter
- List Session Speakers response body has new property:
data[].order
- Get Tables By ID response body has new expandable property
seats
Updated
- Corrections to formatting in the Pagination and Filtering sections of Getting Started.
- Declared the potential 429 response for the following:
- Add Attendees
- Delete Attendee Associations
- Update Internal Information
- Get Session Segments
- Declared the potential 404 response for the following:
- Associate Attendee to Segment
- Create Exhibitor Admin
- Declared the potential 400 response from:
- List Sessions
- POST List Sessions
- Update Attendee revised description of
status
in request body. - Get Table By ID changed its name to Get Table.
- Get Seating By ID changed its name to Get Seating.
- Get Tables changed its name to List Tables.
- Get Seat By ID changed its name to Get Seat.
Deprecated
Removed Beta Endpoints:
- Beta - Get Proposal Draft
- Beta - Update Proposal Draft
- Beta - Cancel Proposal Draft
- Beta - Submit Proposal Draft
- Beta - Validate Proposal Draft
- Beta - Get Proposal
- Beta - Cancel Proposal
Removed Beta Endpoint-Only Scopes:
proposal/proposals:read
: Allows the reading of proposals
REST API Updates (September 18, 2024)#
Added
- New Endpoints:
- Get Housing Requests. Get attendee housing reservation request details for an event.
- Get Communication Config. Gets communication compliance configuration for an account.
- Update Communication Config. Update the communication compliance configuration for an account. For example, configure which communication types will be recorded in the communication log.
- List Communication and POST List Communication. Gets a paginated list of communication log messages from your account. The filter is not required. If no filter is provided then the API will return communication log messages of all types between the specified dates.
- New OAuth2 Scopes:
compliance/communications:read
: Allows the reading of communication compliancecompliance/communications:write
: Allows the writing of communication compliance
Updated
Declared response codes previously not documented:
- 400
- List Contacts
- 404
- Get Contact Group
- Get Ids in Contact Group
- Get, Update, Patch Contact
- Add Contact Relationship
- List, Create Budget Items
- Update Budget Item
- List Budget Totals
- 429
- Merge Contacts
- 400
Update Budget Custom Field Answers: Corrected letter casing typographical error in path: "budget-Items" corrected to "budget-items".
Contacts endpoints and Get Contact Change History:
optOut.by
has new enum value:Cvent Salesforce App
REST API Updates (September 5, 2024)#
Added
- New endpoint Update Quantity Item: Update a given quantity item for an attendee.
- New OAuth2 Scopes
event/quantity-items:write
Updated
- Create Transactions added a new enum to
payment-method
.Express Payment
is now a valid enum. - List Budget Items added
rfpId
field. Includes RFP ID associated with the budget item when the budget item comes from an RFP Budget.
REST API Updates (August 23, 2024)#
Added
- New endpoint List Event Role Assignments. Gets a paginated list of event role assignments associated with a single event.
- New OAuth2 Scope: event/role-assignments:read
Updated
- Some information in the overview sections has been removed and replaced with links to content from the developer guide material.
- Miscellaneous wording improvements.
- Updated Beta Endpoints: Create Proposal Draft and Update Proposal Draft
- In the request,
type
no longer hasVENDOR
as an enum.supplierSummary.type
no longer hasVENDOR
as an enum. - In the response, new properties were added:
responseReason
,responseDetails
.
- In the request,
REST API Updates (August 8, 2024)#
Added
- Delete Attendee Associations. Removes an attendee from an audience segment.
- Create Audience Segment. Creates a new audience segment.
- List Audience Segments. Retrieves a list of audience segments.
- List Audience Segments. Filters audience segments based on specified criteria.
- Update Audience Segment. Updates an existing audience segment.
- Get Audience Segment. Retrieves details of a specific audience segment.
- Delete Audience Segment. Deletes a specific audience segment.
- List Associated Attendees. Retrieves attendees associated with a specific audience segment.
- Associate Attendee to Segment. Adds an attendee to a specific audience segment.
- Disassociate Attendee. Removes an attendee from a specific audience segment.
- List Event Weblinks. Retrieves web links associated with a specific event.
Updated
- List Attendees added
contact.deleted
as a supported filter property. - List Contacts added
optOut.optedOut
as a supported filter property. - The
expand
parameter was improved for the following endpoints:- List Attendees
- POST List Attendees
- Get Attendee
- Various description improvements.
REST API Updates (July 24, 2024)#
Added
- Get Housing Event Info. Gets a list of passkey hotels associated with the event.
- Create Reservation. Creates a hotel reservation.
- Get Reservation. Get hotel reservation details for the given reservation ID.
- Update Reservation. Updates an existing hotel reservation for given reservation ID.
- Cancel Reservation. Cancel hotel reservation for given reservation ID.
Updated
Description improvements were made, including but not limited to the following APIs:
- Get Badge Printer Pool
- Create Badge Print Job
- Upload a File
REST API Updates (July 15, 2024)#
Added
- Get Room Type Inventory response body has new property:
allocation.guaranteed
- Get MR & Get MR by Event ID response body has new properties:
statusNote
code
archiveDate
created(By)
lastModified(By)
- Update MR (Bulk) request body has new property:
statusNote
- Beta - Cancel Proposal added a request body.
- Beta - Validate Proposal Draft request body has new property:
transaction
Updated
- List Custom Fields updated its filter query parameters.
code
is now a supported filter property. - Improved descriptions for various endpoints.
REST API Updates (June 20, 2024)#
Added
- Added new API Update Budget Custom Field Answers. Updates custom field answers for a specific budget item in an event.
Updated
- Miscellaneous operation ID fixes and description improvements.
- Operation IDs were standardized to camelCase for the following endpoints:
- Create Card Transaction
- Update Card Transaction
- Delete Card Transaction
- Update Conversion Rate
- Delete Conversion Rate
- Update Budget Payment
- Delete Budget Payment
- Create Contacts updated
upsert
query parameter description. Clarified that when upserting contacts, the match key can also be a combination of first name, last name, and email. - Description for partialPayments improved to better explain the true and false values of the parameter.
- List Orders response was updated. Order detail has new properties:
- amountOrdered: Total amount for items purchased by the attendee.
- amountPaid: Amount paid by the attendee.
- amountDue: Amount due on the order.
- fee: Fee for a product.
REST API Updates (June 5, 2024)#
Added
- Added new API List Process Form Submissions. Gets a paginated list of process form submissions.
- Create Contacts added new query parameter
upsert
. This parameter determines whether the POST operation should be treated as an upsert. Upserts update existing contacts if they already exist, and otherwise create new contacts. - Get Contact Change History response was changed.
updatedThroughName
added new enum value "REST API". - Beta - Create Proposal Draft, Beta - Get Proposal Draft, and Beta - Update Proposal Draft request
and response bodies added new properties:
statusSummary
represents a summary of status associated with this proposal.billingContractualResponse
represents details about any concessions or contractual requirements from the supplier. This information helps the planner understand the supplier's additional needs or conditions.categoryItemsCost.notes
Notes on category items cost from the venue.
Updated
- Create Bulk Job and Upload Bulk Job Data clarified that a job's data inputs for path-params, query params, and headers must not have null values.
- Create Exhibitor and Get Exhibitor clarified exhibitor title should be limited to 200 chars.
- Update Custom Field Answers request and response bodies updated properties.
type
has new enum values: MultiChoice, OpenEndedDateTime, OpenEndedText, SingleChoice - Create Webcast, Create Webcasts and List Webcasts request and response bodies modified the
title
property. Max length increased from 300 to 500 characters.
Deprecated
- Removed sandbox environment information.
REST API Updates (May 22-23, 2024)#
Added
- Added endpoint Assign Discount to Order Item. Assigns a discount code to an order item based on the given IDs.
Updated
- Miscellaneous description updates.
- Update Speaker.
relevance
property in the request body now has a minimum for values supplied. - List MR Forms and Get MR Form updated
type
enum on response body to include the following new values:MultiChoice
,Number
,OpenEndedDateTime
,OpenEndedText
,SingleChoice
.
REST API Updates (May 8-9, 2024)#
Added
- List Contact Hooks, Create Contact Hook, Update Contact Hook APIs
added new properties:
- Added
security.authHeaderKey
andsecurity.apiKeyPrefix
property.
- Added
- Create Proposal Drafts and Update Proposal Drafts added new properties:
supplierSummary
property was added. This property contains information about the supplier of the proposal draft.categoryItemsCost
property was added. This property contains information about the item costs for all budget categories in the proposal draft.
Updated
- Create Proposal Drafts and Update Proposal Drafts were updated:
proposal
andstatus
property updated to have an additional value ofWITHDRAWN
. This represents the status where a submitter has rescinded their proposal draft.
Deprecated
- List Video Views. The
filter
query parameter has deprecated thedevice.type (eq)
anddevice.operatingSystem (eq)
fields. - Create Proposal Drafts & Update Proposal Drafts. rfpAccountId property was removed.
REST API Updates (April 24, 2024)#
Added
- Added new endpoint List All Seating Assignments. Gets all the table assignments across all the seatings in an event.
- List Seating Assignments Added new
expand
query parameter. Portions of the response can be expanded to include further information on request.
Updated
- Miscellaneous description improvements across the API specification.
REST API Update (April 11, 2024)#
Added
- New Beta endpoint Cancel Proposal. Cancels a proposal based on a given ID.
- List Order Items added the property
guestDetail
. - Update Contacts added the
passport
property.
Updated
- List Meeting Request supports
status
in the filter query parameter. - List Appointments supports
code
in the filter query parameter.
Deprecated
- Update Contacts deprecated the
passportNumber
field in favor of the new passport property.
REST API Update (March 28, 2024)#
Changed usage plan names. They are now: Free, Standard, Premium (changed from Free, Professional, Enterprise).
Addded
The following endpoints were added:
- Create Badge Print Job. Creates a badge print job in an event. Print jobs are supplied to printer pools, and one of the printers will print the job.
- List Badge Print Jobs. Gets a paginated list of badge print jobs.
- Get Badge Print Job. Gets a specific badge print job.
- List Badge Printer Pools. Gets a paginated list of badge printer pools.
- Get Badge Printer Pool. Gets a specific badge printer pool.
- Get Housing Event Reservations. Get list of reservation details for the given housing event.
The following scopes were added:
- 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.
REST API Update (March 15, 2024) #
Added
The following endpoints were added:
Proposal Endpoints
- Create Proposal Draft. Create a new proposal draft.
- Submit a Proposal Draft. Submit a proposal draft.
- Cancel Proposal Draft. Cancel a proposal draft.
- Validate Proposal Draft. Validate a proposal draft before submission.
- Get Proposal Draft. Retrieve details of a specific proposal draft.
Session Endpoints
- Get Session Segments. Retrieve available session segments.
The following additional scopes were added:
proposal/proposals:read
: Allows reading of proposals.proposal/proposals:write
: Allows creation and modification of proposals.
Updated#
Common error response and description updates have been applied across a number of endpoints to improve clarity and consistency.
List Sessions added support for the following filters:
segments (contains|in|is empty| is not empty)
REST API Update (February 25, 2024) #
Added#
Create Transactions. Creates offline transactions for an order in your event. Offline transactions can be any digital or physical transactions performed outside Cvent.
Updated #
List Activities corrected a spelling error in response of the ContactFields model. List Bulk Job Result had its responses updated:
- The description for the 'data' property has been updated to 'Represents a single item that is returned as part of a Bulk request call.'
- Descriptions under error messages were updated.
- code: The HTTP status code representing the error.
- message: A brief description of the error.
- target: The target resource of the error. List Events, Create Event Async, List Events, Get Event, and Update Event had the 'latitude' and 'longitude' properties for venues updated:
- from 'integer' to 'number'.
- property boundaries have been updated from -180 to -90 and 180 to 90 respectively. List Orders had the description for the 'discounts' property changed to 'The list of discount details.' List Order Items had its fields updated:
- The description for the 'discounts' property has been changed to 'The list of discount details.'
- The 'product' property's 'type' attribute now correctly reflects it is read-only. List Transactions updated the 'amount' property to be non read-only. List Transaction Items: The 'product' property's 'type' attribute has been updated to read-only.
Miscellaneous common error response and paging model naming and description updates across a number of endpoints.
REST API Update (February 14, 2024)#
Updated#
List Sessions was updated:
- Added
match
comparison type, which lets you search all the fields of a session with a single string. Each session returns with a relevance score. This allows for more nuanced searches, helping users find sessions that best match their criteria. - Expanded sort query parameter to include new fields: end, includedSession, category.name, code, and relevance.
List Speakers and POST List Speakers Added
match
comparison type, which lets you search all the fields of a speaker with a single string. Each speaker returns with a relevance score. This allows for more nuanced searches, helping users find sessions that best match their criteria.
Misc. error response description updates across a number of endpoints.
REST API Update (January 10, 2024)#
Updated
The Venue Address model was updated on event APIs. The latitude and longitude fields changed their data type from integer
to number
.
This change means latitude/longitude fields can now store floating point numbers. This change allows for more accurate location data to be stored in Cvent.
REST API Updates (December 21, 2023)#
Added
- List Currency Conversion Rates. Gets a paginated list of conversion rates for a currency in an account.
- Create Conversion Rate. Create conversion rate for a currency in an account.
- Delete Conversion Rate. Deletes conversion rate defined for currency.
- Update Conversion Rate. Updates a conversion rate for a currency in an account.
Updated
The paging and/or error responses descriptions were updated for many the API endpoints enumerated below.
- List Session's Speakers
- List Speakers Categories
- Create Speaker Category
- List Speakers
- Create Speaker
- List Speakers
- Delete Speaker
- Update Speaker
- List Speaker's Documents
- Delete Document From Speaker
- Get a Document For a Speaker
- Add Document To Speaker
- Delete Speaker Profile Picture
- Assign Speaker Profile Picture
- Delete Webcast
- List Video Views
- List Audio Tracks
- List Video Renditions
- List Text Tracks
- Create Text Track
- Update Text Track
- List Webcasts
- Create Webcast
- List Attendee Links
- Delete Attendee Link
List Videos updated generatedThumbnail
and thumbnail
fields descriptions to clarify they contain links.
List Players updated enum options for status
to include [Starving].
Update Attendee Link updated response description.
REST API Updates (December 14, 2023)#
Added
- Update Event Registration Type. Updates a registration type in an event. This will allow users to update the total capacity for a particular registration type in an event.
Updated
List Registration Types returns three capacity related fields:
remaining
will return the remaining capacity for the registration type.consumed
will return the consumed capacity for the registration type.total
will return the total capacity for the registration type.
The paging and error responses descriptions were updated for the following API endpoints:
- List Appt Attendees
- Get Appt Attendee
- List Availability
- Get Availability
- List Appt Events
- Get Appt Event
- List Available Times
- List Appointment Types
- Create Appointment
- Create Appointment
- Cancel Appointment
- List Locations
- List Interests
- Get Interest
- List Appointments
- Get Appointment
- List Attendees
- List Attendees
- List Attendees
- Get Attendee
- Update Attendee
- Update Internal Information
- List Custom Fields
- Create Custom Field
- Get Custom Field
- Update Custom Field
- Update Advanced Logic
- Update Advanced Logic
REST API Updates (November 30, 2023)#
Added
New endpoints added:
- Delete Contact Hook. Delete a contact hook's details.
- List Emarketing Email Status. Gets the status of email using unique email request ID that was generated as a response of Send Email To Recipients request.
- Send Email To Attendees. Sends an email to one or more event attendees who are on the invitation list.
- List Event Email Status. Gets the status of email using unique email request ID that was generated as a response of Send Email To Attendees request.
- List Event Emails. Gets a paginated list of emails for a given event.
- List Invitation Lists. Gets a paginated list of invitation lists for a given event.
New Budget endpoints added. Budget is an event feature used to organize spending and track allocations. Use these APIs to view budget items, cards and card transactions related to the budget module.
- Create Budget Payment. Create single payment for the budget item given in an event.
- Delete Budget Payment. Deletes a budget item payment.
- Update Budget Payment. Updates a budget item payment.
- List Budget Payments. Gets a paginated list of payments for budget items in an event.
- Assign Invoice To Payment. Assign a single invoice to a payment using the ID of file. Upload files via the file upload endpoint.
New Seating endpoints added. Seating lets you plan seating at your events by configuring tables and assigning seats to your attendees. The seating APIs allow you to create, update, and delete seating, tables, seats, and seating assignments.
- List Seating. Get seating details for the given event.
- Get Seating By ID. Get seating details for the given event by seating ID.
- Get Attendee Table Assignment. Gets the table assignment for a given attendee across all the seatings in an event.
- Get Tables. Get table details for a given seating.
- Get Table By ID. Get table info for given event by seating ID and table ID.
- Get Seats. Get seat details for given table ID.
- Get Seat By ID. Get seat info for given event by seating ID, table ID, and seat ID.
Deprecated
Endpoint deprecated:
- List Email Status
Updated
The following endpoints modified their enum options to include SIMPLE
. Import appointments or let attendees schedule
them without any restrictions or prior setup.
- List Appt Events
- Get Appt Event
The following endpoints added a new question
property, which contains the unique ID of the question.
- List Responses
- List All Event Responses
- Create Event Survey Responses
- List Event Survey Responses
- List Stdl. Survey Responses
- Create Stdl. Survey Responses
- Update Stdl. Survey Responses
Send Email To Recipients added two new properties:
description
The description of the request status. If the status is ERROR, this field contains the reason for the failure.status
Denotes the status of the send email request.
List Registration Types made the virtual
field read-only.
The following endpoints added the compositeValue
property. This is the set of answers to a complex questions, which is READ-ONLY.
A complex question can be Meeting Room requirement, Sleeping Room requirement or Budget Estimate according to the question ID.
- Get MR by Event ID
- List MR
- Create MR (Bulk)
- Update MR (Bulk)
- Get MR
REST API Updates (November 15, 2023)#
Added
New endpoints:
- Create Transactions. Create offline transactions for an order in your event.
- List Video Views. Gets a paginated list of video views in your account.
- List Sessions added a new filter operator for the title field:
match
. Thematch
filter searches the title field and returns results based on relevance. - List Attendees added a new property:
pronouns
. This field identifies the attendee's preferred pronouns. - Get Attendee added a new property:
pronouns
. This field identifies the attendee's preferred pronouns.
Deprecated
- Update Attendee added a new property:
pronouns
. This field identifies the attendee's preferred pronouns. - List Attendees deprecated a property:
pronoun
. Usepronouns
instead. - Get Attendee deprecated a property:
pronoun
. Usepronouns
instead. - POST List Events deprecated filtering on the title field with the operator
contains
.
REST API Updates (October 25, 2023)#
Added
New endpoints:
- Get Contact Change History. Get the change history for a specific contact.
- List Attendance Duration. Added the id field, representing the unique ID of the attendance duration record.
- List Attendees. Added new property appointmentGroups. This lists appointment groups associated with the attendee.
- List Players. Added new property session. This field provides information about the livestream's current streaming session.
Updated
- Create Appointment updated the code field:
- Description clarifies the field represents a unique appointment code in Cvent, or a unique reference ID of an appointment in an external system.
- Minimum length is now 1 character.
- Pattern changed to
^[a-zA-Z0-9-.%]+$
- Update Appointments updated the code field:
- Description clarifies the field represents a unique appointment code in Cvent, or a unique reference ID of an appointment in an external system.
- Minimum length is now 1 character.
- Pattern changed to
^[a-zA-Z0-9-.%]+$
- List Appointments updated the code field:
- Description clarifies the field represents a unique appointment code in Cvent, or a unique reference ID of an appointment in an external system.
- Minimum length is now 1 character.
- Pattern changed to
^[a-zA-Z0-9-.%]+$
- Get Appointment updated the code field:
- Description clarifies the field represents a unique appointment code in Cvent, or a unique reference ID of an appointment in an external system.
- Minimum length is now 1 character.
- Pattern changed to
^[a-zA-Z0-9-.%]+$
- List Attendees modified filterable fields to add appointmentGroup.id (eq|ne)
- List Budget Totals modified filterable fields to add version.default (eq|ne)
REST API Updates (October 11, 2023)#
Added
New endpoints:
- Create Custom Fld. Translation: Creates translations for a single custom field based on the values provided.
- Update Custom Fld. Translation: Updates translations for a single custom field based on the values provided.
- List Exhibitor Files: Retrieves a list of files associated with an exhibitor.
- Disassociate Exhibitor File: Disassociate a single file from an exhibitor.
- Get Exhibitor File: Get a single file for an exhibitor.
- Associate Exhibitor File: Associate a file to an exhibitor using a file ID taken from the file upload endpoint.
- List Exhibitor Weblinks: Retrieves a list of content weblinks associated with an exhibitor.
- Create Exhibitor Weblink: Creates a single content weblink for an exhibitor.
- Delete Exhibitor Weblink: Deletes a single exhibitor content weblink.
- Get Exhibitor Weblink: Retrieves a single content weblink for an exhibitor.
- Update Exhibitor Weblink: Updates content weblink data in an event for a given exhibitor ID.
- List Respondents added new properties:
- attempt counts the number of times a respondent has attempted the survey and answered the question.
- evaluationResult represents the evaluation status of an assessment chapter.
- List Responses added new property: attempt counts the number of times a respondent has attempted the survey and answered the question.
- List Attendees, POST List Attendees, Get Attendee, Update Attendee, added new properties:
- biography: A field for the attendee's biographical information.
- headline: The headline of the attendees profile, which summarizes their professional experience and qualities.
- personalWebsite: The attendees personal website URL.
- The Contact object added secure contact fields, which are only retrieved when the requester has the required event/contacts:read-sensitive scope. These secure contact fields are available on the Contacts endpoints:
- dateOfBirth: The date of birth of the contact.
- passportNumber: The passport number of the contact.
- socialSecurityNumber: The social security number of the contact.
- nationalIdentificationNumber: The national identification number of the contact.
- The following scopes were added:
- Scheme OAuth2.authorizationCode Added scopes: [event/contacts:write-sensitive]
- Scheme OAuth2.clientCredentials Added scopes: [event/contacts:write-sensitive]
Updated
- List Custom Fields, Create Custom Field, Update Custom Field, Get Custom Field were updated to clarify that auto-increment custom fields are read-only since the intended use is to allow Cvent to control the incrementation of values.
- Update Advanced Logic descriptions changed to clarify default choices. Leave empty to have no choices displayed as default.
- Exhibitor endpoints had minor updates to their field descriptions.
- List Respondents updated the supported fields for filtering:
- score (eq|ne|gt|ge|lt|le)
- chapters.score (eq|ne|gt|ge|lt|le)
- chapters.evaluationResult (eq|ne)
- chapters.status (eq|ne)
REST API Updates (September 2023)#
Added
- Added new endpoints:
- Update Advanced Logic lets you update the advanced logic on custom fields.
- Get Air Actual gets attendees air actual details for an event.
- Get Air Requests gets attendee air request details for an event.
- Get Hotel Requests gets attendee hotel requests for an event.
- List Large Choices gets a paginated list of choices for large-choice questions.
- Added OAuth2 Authorization Code flow support to Transaction and Order endpoints.
- List Speakers added the
locale
query parameter, allowing you to specify the desired locale of values returned. - Create Appointment allows you to specify a code for the appointment.
Updated
- List Event Survey Questions, List Stdl. Survey Questions and List Questions updated to support a new
type
of question, large choice questions. - List Questions updated filterable fields to include
maxScore
. - List Card Transactions updated filterable fields to include
reconciliations.reconciledDate
. - Documentation updated to clarify only one filter at a time is supported on the following endpoints:
- List Availability
- List Available Times
- List Interests
- List Appointments
- List Surveys: updated supported types of surveys to include assessment.
REST API Updates (August 2023)#
Added
The following new endpoints were added:
- List Session Categories. Gets a paginated list of session categories in your account.
- Create Session Categories. Create a session category in your account.
- Update Custom Field. Update custom field answers for a single custom field and single session.
The following OAuth scopes were added:
- event/session-categories:read
- event/session-categories:write
New weblink
property was added to response from List Event Features and Update Event Feature.
Updated
Descriptions of the Housing and Video tags were updated to include more details.
The following endpoints were updated:
- Create Connection. Field descriptions were updated.
- Get Housing Event Info. Field descriptions were updated.
- Get Reservation Request. Field descriptions were updated.
- Create Contact Hook. Description clarified for callback security mechanisms
- List Exhibitors.
limit
andtoken
query parameters added for pagination control - List Exhibitor Admins.
limit
andtoken
query parameters added for pagination control - List Booth Staff.
limit
andtoken
query parameters added for pagination control - List Registration Paths.
local
query param added - List Enrollments.
before
andafter
query parameter behaviour description corrected - Create & Delete Delete Session Enrollment. Field descriptions were updated.
- Assign Speaker to Session. Field descriptions were updated.
REST API Updates (July 2023)#
Added
Added new endpoints:
- List Videos. Gets a paginated list of videos associated with your account or event.
- List Audio Tracks. Gets a list of audio tracks for a specific video ID.
- List Video Renditions. Gets a list of video renditions for a specific video ID.
- List Text Tracks. Gets a list of video text tracks for a specific video ID.
- Create Text Track. Creates a new text track (VTT) object for a specific video. This endpoint does not directly handle the upload of VTT files but instead returns a location URL that you use to perform the upload.
- Update Text Track. Updates a specific video text track by ID. This is done by setting the status to Updating within the body of this call, which will prompt the service to return a signed upload link in the returned entity.
- Delete Contact. Deletes a contact from the address book but does not remove the contact from events.
- Merge Contacts. Merges two or three contacts into a single contact.
- List Contact Hooks. Gets a list of contact hooks. A Hook is a URI pointing to your system. When requested, Cvent will retrieve contact data from this URI and populate a contact’s details.
- Create Contact Hook. Creates a contact hook with an callback URI to fetch updated information for contacts.
- Update Contact Hook. Update a contact hook’s details, including its associated callback URI.
- List Email Status. Gets the status of emails using unique email request ID that was generated as a response of Send Email To Recipients request.
- List Email Templates. Gets a list of eMarketing email templates.
- Send Email To Recipients. Sends an email to one or more eMarketing campaign recipients who are on the recipient list.
- List eMarketing Campaigns. Gets a list of eMarketing campaigns.
- List Questions. Gets a paginated list of event and standalone surveys questions.
- List Respondents. Gets a paginated list of event and standalone surveys respondents.
- List Responses. Gets a paginated list of event and standalone survey responses.
Added new enum values to the attendee activities type
field:
- event.bannerLinkClicked. The link on the banner clicked by an attendee.
- event.customCardOpened. When a custom card is opened by an attendee.
- session.pollResponseSubmitted. The poll created for a session.
- session.questionAsked. The question asked activity details for the session.
- session.questionUpvoted. This denotes the question asked in the session.
Updated
Updated a number of endpoints to support auth code flow.
Updated Create Contact Group endpoint to support filtering on type
field.
Updated attendee response, added following enums:
- Administrator Responded Widget
- Group Leader Responded Widget
- Self-Responded Widget
Deprecated
The following fields were deprecated from the contact model:
event
event.id
parentId
REST API Updates (June 2023)#
Updated
The following fields were updated:
- The event object’s
type
field was updated.CventWebinar
was added as a valid option andHostedWebinar
was removed. - The webcast object’s
solutionType
field was updated.Embedded Cvent Studio
was added as a valid option.
Added
Additional fields were added to the following objects:
- The contact object had the
nickname
field added. This is an alternate name the contact is known by. - The budget item object had the
deleted
field added. True indicates the budget item is deleted. - The webcast object had the
autoAddToLibrary
field added. This field indicates if live stream recordings will automatically be saved to the library. - The file object had the
fileSize
field added. This field describes the size of the file in bytes.
The following endpoints were added:
- Delete Card Transaction. Allows you to delete a credit card transaction record.
- Update Card Transaction. Allows you to update a credit card transaction record.
- List Contact Types. Gets a paginated list of contact types in your account.
- Create Custom Field. Creates a single custom field based on the values provided.
- Update Custom Field. Updates a custom field based on the given custom field ID.
Additional query parameters were added to endpoints:
- List Event Surveys added
before
andafter
. - List Standalone Surveys added
before
andafter
. - List Surveys added
before
andafter
.
We have expanded Authorization Code flow support across many endpoints.
REST API Updates (April 2023)#
Updated
Appointment event object had the defaultLocale
field erroneously documented as a string. It now correctly displays as a boolean.
Planners object had the deleted
field’s default value erroneously documented as true. It now correctly displays as false.
Survey object had the id
field corrected and now displays as readOnly.
Added
Appointment event object had the following fields added:
- compliance. Contains a contact’s privacy preferences under various legislations.
- npi. Unique 10-digit identification number issued by the Centers for Medicare and Medicaid Services for health care providers in the United States.
Attendee object had the following fields added:
- registrationCancelledAt. The ISO 8601 zoned date time when attendee registration was cancelled.
Exhibitor object had the following fields added:
- bannerId. The file ID for the exhibitor banner.
- bannerUrl. The URL for the exhibitor banner.
- profileLogoId. The file ID for the exhibitor profile logo.
Exhibitor categories object had the following fields added:
- bannerId. The file ID for the exhibitor banner.
- bannerUrl. The URL where the exhibitor banner is stored.
The following endpoints were added:
- Assign Exhibitor Logo Image. Assign a logo image to an exhibitor with a file UUID from the file upload endpoint. This will replace the current logo image if one is assigned.
- Assign Banner to Category. Assign a banner image to an exhibitor category with a file UUID from file upload endpoint. This will replace the current banner image if one is assigned.
- Assign Exhibitor Banner Image. Assign a banner image to an exhibitor with a file UUID from file upload endpoint. This will replace the current banner image if one is assigned.
We have expanded Authorization Code flow support across many endpoints.
Deprecated
Attendee object had the following field deprecated:
- checkin. This field is deprecated; use checkIn instead.
REST API Updates (March 2023)#
Updated
The available filters for contacts were updated:
firstName
can be filtered using the following operators (eq|ne|contains)lastName
can be filtered using the following operators (eq|ne|contains)email
can be filtered using the following operators (eq|ne|contains)
The available filters for sessions were updated:
registrationTypes
can be filtered using the following operators: (contains|is empty|is not empty)admissionItems
can be filtered using the following operators: (contains|is empty|is not empty)
The attendee object was updated to include the following property:
compliance
, which contains details related to the attendee’s specified preferences for CCPA compliance.
The contact object was updated to include the following properties:
compliance
, which contains details related to the attendee’s specified preferences for CCPA compliance.npi
, which contains the contact’s 10-digit ID for US Medicare and Medicaid services.
The following endpoint was updated:
Create & Update Webcast. Now has a 409 response, which indicates the action you’re performing conflicts with a setting on the targeted webcast.
The Authentication section was updated. Authorization code flow is supported for Cvent planner-side users with an administrator role. Other types of users cannot currently leverage authorization code flow.
Added
New endpoints were added:
- Get Housing Event Hotels. Get a list of hotels from your Passkey housing events.
- Get Housing Event Hotel. Get a single hotel from your Passkey housing event.
- Get Event Hotel Availability. Get a list of available nights for a particular hotel in a Passkey housing event.
- Get Housing Event Room Types. Get a list of room types for a particular hotel in a Passkey housing event.
- Get Room Type Details. Get details related to a particular room type in Passkey.
- Get Room Type Inventory. Get a list of room type inventory details by date for a particular room type in Passkey.
REST API Updates (February 2023)#
Updated
Attendance duration can now be filtered by:
event.id
(eq|ne|in) of the related event.session.id
(eq|ne|in) of the related session.attendee.id
(eq|ne|in) of the related attendee.type
(contains|eq|ne|in), or the method that duration was marked (via OnArrival, RFID tracker, added via API, etc.)
Sessions can now be filtered by customField
, where you supply the uuid of a custom session field.
Added
New filters have been added to transactions and transaction items. These can be filtered by their processorTransactionId
, the unique ID of the payment processor.
Event survey’s question type field has a new option: NumberAllocation
. This type of question is one where respondents provide numbered responses to specific categories that must add up to a specific value.
New properties have been added to Reservation Requests
externalId
is a unique ID from an external system.attendeeType
is the attendee‘s type in the housing event where the reservation request originates from.roomType
is the type of room requested.rewardProgram
is the reward program associated with the reservation request.membershipId
is the unique ID of the user in the reward program.travelDetails
The specifics of the reserver’s flights include arrival, departure and additional notes.bookingContact
is the group booking’s unique ID.
A new sort option was added to speakers.
New endpoints were added:
- Launch Event Features. Activates event features in your event.
- Get Resource Type. Gets the details of a single resource type for Cvent’s implementation of SCIM.
- Get Schema. Gets the details of a user schema and its extension models representing the user and SCIM groups (representing Cvent user roles). This endpoint works with account users only and excludes other types like portal users.
- List Users. Gets a list of users in your account. This endpoint works with account users only and excludes other types like portal users.
Deprecated
Attendance duration had one filter removed. durationType
was removed.
REST API Updates (January 2023)#
Added
New User Management APIs have been added. The APIs follow the System for Cross-domain Identity Management (SCIM) standard. Using this standard, user data is stored consistently and can be easily communicated across different apps. For more details, please refer to API documentation. The User Management APIs allow you to manage your account users, including:
- Create, update, retrieve and delete users.
- Mark a user active/inactive.
- Retrieve service provider configuration, resource types and schemas.
Two new Contact Obfuscation endpoints have been added. An Obfuscation User Guide helps explain the workflow of using these two endpoints:
Obfuscate a Contact
allows you to begin an asynchronous obfuscation process of a contact’s personal details.Get Contact Obfuscation Status
lets you check the status of an obfuscation request.
List Attendees
and Get Attendees
endpoints now have a expand
parameter. The expand
parameter lets you specify if you want additional information returned in the response. Currently supported are registration answers and registration type.
Copy event
endpoint now supports creating a new event with copied data or adding copied data to an already existing event.
Update Event Feature
endpoint can now enable/disable pricing in an event.
Updated
Some endpoints have been re-organized into new sections in the documentation:
- Moved the Badge endpoints under the Attendee section.
- Moved the Exhibitor Admin endpoints under the Exhibitor Team section.
- Moved the Lead endpoint under the Leads section. Updates to meeting request endpoint descriptions.
New filters added to speaker endpoint: company
and title
.
Updated getting started section:
- Expanded Authentication to clarify how to obtain & use an access token.
- Expanded Country Codes to describe country codes that do not follow the ISO 3166 standard.
- Expanded pagination to better explain how to browse pages and understand when there are no more pages.
- Expanded filtering to better explain how to use filters, especially when special characters are involved.
- Expanded section on tracking changes to your data.
Updated attendance duration
description. Duration is calculated based on the attendee‘s total time in the session, not just when they were first and last seen.
REST API Updates (November 2022)#
Added
Appointments
A new endpoint was added for appointments.
Update Appointments
allows you to update the details of existing appointments in your account.A new parameter was added to appointments.
supressNotification
denotes if hosts and attendees should receive configured notifications about changes to an appointment. SurveyThe survey object has a new array.
Events
denotes the list of events associated with a survey.
REST API Updates (November 2022)#
Updated
The speaker title
field had its maximum length increased from 50 to 100.
Assign Speaker to Session
endpoint can now assign speakers to a category via the speakerCategory field.
Added
Budget
- Card details have the following new fields:
billingAccountId
represents the billing account id for the virtual card.fullName
represents the first and last name of the user who requested the card.reportingFields
contain a list of report field names and their corresponding value.cardHolderName
represents the name of the cardholder.last7
represents the card’s last seven digits.
- Card transactions have a new
description
field which represents a user input description of the card.
Session
- Session object now has an
admissionItems.id
field, which indicates what admission item a session is included with. List sessions
endpoint can now filter sessions based on locale.
Survey
- Standalone surveys added a
customField
array, which contains all the user-input custom field names, codes and their values. - Requests to the
List surveys
endpoint can now set alimit
parameter to control results per page and atoken
parameter to select a page of results to view.
Deprecated
The session attendance objects duration
field is deprecated. Durations can now be found with the List attendance duration endpoint.
REST API Updates (October 2022)#
Updated
The attendee object has additional values for the responseMethod field:
- Cvent Salesforce App
- Cvent Salesforce App – Campaign Page
- Cvent Salesforce App – Contact Page
- Cvent Salesforce App – Event Page
- Cvent Salesforce App – Lead Page
- Cvent Salesforce App – Person Account Page
- Cvent Salesforce App – Recommendation Widget
The attendee object had the following responseMethod
value removed: Events App for Salesforce.
The Update Attendee
action now supports adding a paid session.
Other minor documentation improvements.
Added
New properties have been added to existing objects:
- Hotel Reservation added the callCenter field to store the URL for the passkey call center.
- Transaction object added the reconciliations field to allow users to assign a transaction to a budget item.
- Event Survey object added the parentId field to denote the parent survey.
- Session object added the following:
automaticallyOpensOn
indicates the date/time the session will automatically open for registration.automaticallyClosesOn
indicates the date/time the session will automatically close for registration.waitlistCapacity
indicates the maximum number of registrants that can waitlist a session.displayOnAgenda
indicates if the session should display on the event’s website promotional pages.
New endpoints have been added:
Appointments
List Appointment Types
lists all the appointment types attendees or planners can choose for a particular event.List Locations
lists all the appointment locations where attendees can meet at a particular event.
Events
Create Event Async
lets you create a new event and populates its details.Get Event Async Status
lets you check the status of a create event request.Update Event
lets you update the details of an existing event.Copy Event
lets you copy an existing event and select which features to copy.Get Event Copy Status
lets you check the status of a copy event request.
Event Features
Get Event Features
lets you view the features enabled on a particular event.Update Event Features
lets you update an event and enable/disable a feature, like registration or surveys.
Exhibitors
List Exhibitor Registration Packs
retrieves all registration packs associated with an exhibitor in an event.
Surveys
List Surveys
list all event and standalone surveys in the account.
REST API Updates (September 2022)#
Updated
The event object fields start
and end
are no longer marked as required information.
The external activity field additionalProperties is now correctly documented as a string field.
Added
The speaker object has exposed a new field category
, a planner-defined field that helps organize speakers in an event.
The standalone survey object has two new fields:
archiveAfter
the date the survey should archive.closeAfter
the date the survey should close for responses.
There are eight new endpoints added:
Update Attendee Internal Information
lets you add internal information to an attendee. Commonly used to store event-specific data about an attendee.List Event Features
shows the features an event has activated, like Registration or Attendee Hub.Update Event Feature
lets you activate or deactivate an event’s features.List Event Orders
shows a list of orders made by attendees in an event.List Event Order
Items shows a list of the items ordered by attendees in an event, like specific sessions or quantity items. *List Event Transactions
shows a list of posted transactions in an event.List Event Transaction Items
shows a list of items for posted transactions in an event.Cancel Appointment
lets you cancel an existing appointment.