openapi: 3.2.0 info: title: Cvent REST Contacts API description: '# Introduction The Cvent API Platform is built around REST.' contact: name: Cvent Development Platform url: https://developers.cvent.com/ version: ea servers: - url: https://api-platform.cvent.com/ea - url: https://api-platform-eur.cvent.com/ea tags: - name: Contacts description: A contact is a record in your account’s address book that represents an individual. The data stored within these records includes personal information, group memberships, and historical data on event attendance. Contact APIs will allow you to get contact information, track updates to contact information, and create contacts. paths: /contact-groups: post: security: - OAuth2.clientCredentials: - event/contact-groups:write - OAuth2.authorizationCode: - event/contact-groups:write summary: Create Contact Group description: Create a contact group operationId: createContactGroup tags: - Contacts requestBody: description: Contact Group to be created required: true content: application/json: schema: $ref: '#/components/schemas/contact-group' responses: '201': description: Successfully created a contact group. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-group' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' get: security: - OAuth2.clientCredentials: - event/contact-groups:read - OAuth2.authorizationCode: - event/contact-groups:read summary: List Contact Groups description: Gets a paginated list of contact groups operationId: listContactGroups tags: - Contacts parameters: - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/before' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/token' - name: filter in: query required: false description: 'Use filter query parameters to limit results to data that matches your criteria. See [Filters](/docs/rest-api/reference/filters) for details. Supported fields and operators are listed below: | Field | Operators | Notes | |------------------|-------------------------------------|-------| | name | `eq`, `ne`, `sw`, `contains` | | | type | `eq` | Not supported with before or after parameters | The following logical operators are supported for combining filters: * and ' schema: type: string example: name eq 'groupName' and type eq 'STANDARD' responses: '200': description: Successfully retrieved a paginated list of Contact Groups. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-group-paginated-response' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contact-groups/{id}: parameters: - $ref: '#/components/parameters/contactGroupId' get: security: - OAuth2.clientCredentials: - event/contact-groups:read - OAuth2.authorizationCode: - event/contact-groups:read summary: Get Contact Group description: Get a single contact group operationId: getContactGroupById tags: - Contacts responses: '200': description: Successfully retrieved a Contact Group object. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-group' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' put: security: - OAuth2.clientCredentials: - event/contact-groups:write - OAuth2.authorizationCode: - event/contact-groups:write summary: Update Contact Group description: Update a contact group operationId: updateContactGroup tags: - Contacts requestBody: description: Contact Group to be updated required: true content: application/json: schema: $ref: '#/components/schemas/contact-group' responses: '200': description: Successfully updated a contact group. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-group' '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' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' delete: security: - OAuth2.clientCredentials: - event/contact-groups:write - OAuth2.authorizationCode: - event/contact-groups:write summary: Delete Contact Group description: Delete a contact group operationId: deleteContactGroup tags: - Contacts responses: '204': description: Successfully deleted a contact group. headers: {} '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contact-groups/{id}/contacts: parameters: - $ref: '#/components/parameters/contactGroupId' get: summary: Get Ids in Contact Group description: Get all contact ids in a single contact group operationId: getContactIdsByContactGroup security: - OAuth2.clientCredentials: - event/contact-groups:read - OAuth2.authorizationCode: - event/contact-groups:read tags: - Contacts parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/token' responses: '200': description: Successfully retrieved Contact ids. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-id-paginated-response' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contact-groups/{id}/contacts/{contactId}: parameters: - $ref: '#/components/parameters/contactGroupId' - $ref: '#/components/parameters/contactId' put: summary: Add Contact To Group description: Adds a single Contact to a single Contact Group operationId: addContactToContactGroup security: - OAuth2.clientCredentials: - event/contact-groups:write - OAuth2.authorizationCode: - event/contact-groups:write tags: - Contacts responses: '204': description: Successfully added Contact to Contact Group headers: {} '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' delete: summary: Remove Contact From Group description: Removes a single Contact from a single Contact Group operationId: removeContactFromContactGroup security: - OAuth2.clientCredentials: - event/contact-groups:write - OAuth2.authorizationCode: - event/contact-groups:write tags: - Contacts responses: '204': description: Successfully removed a Contact from a Contact Group headers: {} '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contact-types: get: security: - OAuth2.clientCredentials: - event/contact-types:read - OAuth2.authorizationCode: - event/contact-types:read summary: List Contact Types description: Gets a paginated list of contact types. operationId: listContactTypes tags: - Contacts parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/token' - name: filter in: query required: false description: 'Use filter query parameters to limit results to data that matches your criteria. See [Filters](/docs/rest-api/reference/filters) for details. Supported fields and operators are listed below: | Field | Operators | |------------------|-------------------------------------| | name | `eq`, `ne`, `sw`, `contains` | No logical operators are supported on this endpoint, only one filter can be passed in each request. ' schema: type: string example: name eq 'groupType' responses: '200': description: Successfully retrieved a paginated list of contact types. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-type-paginated-response' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contacts: get: security: - OAuth2.clientCredentials: - event/contacts:read - OAuth2.authorizationCode: - event/contacts:read summary: List Contacts description: 'Gets a paginated list of Contacts. For information on reading secure contact fields, see the description of GET Contact.' operationId: listContacts parameters: - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/before' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/token' - name: filter in: query required: false description: 'Use filter query parameters to limit results to data that matches your criteria. See [Filters](/docs/rest-api/reference/filters) for details. Supported fields and operators are listed below: | Field | Operators | Notes | |------------------|-------------------------------------|-------| | id | `eq`, `ne` | | | sourceId | `eq`, `ne` | | | firstName | `eq`, `ne`, `contains`, `sw` | | | lastName | `eq`, `ne`, `contains`, `sw` | | | email | `eq`, `ne`, `contains`, `sw` | | | ccEmail | `eq`, `ne` | | | company | `eq`, `ne` | | | type.id | `eq`, `ne` | | | nickname | `eq`, `ne` | | | title | `eq`, `ne` | | | workPhone | `eq`, `ne` | | | middleName | `eq`, `ne` | | | mobilePhone | `eq`, `ne` | | | homeFax | `eq`, `ne` | | | designation | `eq`, `ne` | | | homePhone | `eq`, `ne` | | | pager | `eq`, `ne` | | | workFax | `eq`, `ne` | | | lastModifiedBy | `eq`, `ne` | | | lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` | | | created | `eq`, `ne`, `lt`, `le`, `gt`, `ge` | | | createdBy | `eq`, `ne` | | | workAddress.address1 | `eq`, `ne` | | | workAddress.address2 | `eq`, `ne` | | | workAddress.address3 | `eq`, `ne` | | | workAddress.city | `eq`, `ne` | | | workAddress.country | `eq`, `ne` | | | homeAddress.address1 | `eq`, `ne` | | | homeAddress.address2 | `eq`, `ne` | | | homeAddress.address3 | `eq`, `ne` | | | homeAddress.city | `eq`, `ne` | | | homeAddress.country | `eq`, `ne` | | | deleted | `eq`, `ne` | Filters for deleted contacts. To retrieve purged contacts, see the `includePurged` parameter. | | customField.{uuid of custom field} | `eq`, `ne`, `lt`, `le`, `gt`, `ge`, `sw`, `contains` | | | optOut.optedOut | `eq`, `ne` | | The following logical operators are supported for combining filters: * and * or ' schema: type: string example: firstName eq 'John' or lastName eq 'Anderson' - $ref: '#/components/parameters/includePurged' tags: - Contacts responses: '200': description: Successfully retrieved a Paginated list of Contacts. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-paginated-response' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' put: security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write summary: Update Contacts description: 'Updates a list of contacts based on the values provided in the request body. If you''re changing de-duplication fields, the new values must be unique in your account. For information on updating secure contact fields, see the description of PUT Contact.' operationId: updateContacts tags: - Contacts requestBody: description: List of contacts to be updated. Up to **10 contacts** can be updated per call. required: true content: application/json: schema: $ref: '#/components/schemas/contact-bulk-update' responses: '207': description: Successfully updated a list of Contacts. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-bulk-response' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' patch: security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write summary: Patch Contacts description: 'Updates a list of contacts based on the values provided only, keeping the existing values intact for every contact. For information on PATCH behavior, see the description of PATCH Contact. For information on updating secure contact fields, see the description of PUT Contact.' operationId: patchContacts tags: - Contacts requestBody: description: List of contacts to be updated. Up to **10 contacts** can be updated per call. required: true content: application/json: schema: $ref: '#/components/schemas/contact-bulk-patch' responses: '207': description: Successfully updated a list of contacts. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-bulk-response' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' post: security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write summary: Create Contacts description: 'Creates a list of contacts based on the values provided in the request body. If you''re changing de-duplication fields, the new values must be unique in your account. For information on creating contacts with secure contact fields, see the description of PUT Contact.' operationId: createContacts tags: - Contacts parameters: - name: upsert in: query required: false description: '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. True indicates that this operation creates new contacts and updates existing contacts if they exist. False means that it only creates new contacts, and attempting to create an existing contact will result in the API returning an error. Existing contacts are matched to the upsert request via the account''s [match key](https://support.cvent.com/s/communityarticle/Allowing-Multiple-People-to-Use-the-Same-Email-Address). By default, the match key for contacts is their email. The match key can also be altered to match contacts based on a combination of their first name, last name, and email. ' schema: type: boolean example: true default: false requestBody: description: List of contacts to be created. Up to **10 contacts** can be created per call. required: true content: application/json: schema: $ref: '#/components/schemas/contact-bulk-create' responses: '207': description: Successfully created a list of contacts. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-bulk-response' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contacts/filter: post: security: - OAuth2.clientCredentials: - event/contacts:read - OAuth2.authorizationCode: - event/contacts:read summary: List Contacts description: 'Gets a paginated list of Contacts by sending a filter in the body of the request. This method will return the same data as the GET List Contacts but allows for longer filters. For information on reading secure contact fields, see the description of GET Contact.' operationId: listContactsPostFilters requestBody: description: See the request body of GET List Contacts for full filtering information required: false content: application/json: schema: $ref: '#/components/schemas/filter' example: filter: firstName eq 'John' or lastName eq 'Anderson' parameters: - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/before' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/token' tags: - Contacts responses: '200': description: Successfully retrieved a Paginated list of Contacts. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-paginated-response' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contacts/obfuscate/{obfuscateId}/status: parameters: - $ref: '#/components/parameters/obfuscateId' get: summary: Get Obfuscation Status description: Get the obfuscation status of a contact by the Obfuscate ID provided. operationId: getContactObfuscationStatusById security: - OAuth2.clientCredentials: - event/contacts:read - OAuth2.authorizationCode: - event/contacts:read tags: - Contacts responses: '200': description: Successfully retrieved a contact's obfuscation status. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-obfuscation-status' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contacts/{contactId}/history: get: summary: Get Contact Change History description: Get the change history for a specific contact. security: - OAuth2.clientCredentials: - event/contacts:read - OAuth2.authorizationCode: - event/contacts:read tags: - Contacts operationId: getChangeHistoryForASpecificContact parameters: - $ref: '#/components/parameters/contactId' - $ref: '#/components/parameters/before' - $ref: '#/components/parameters/after' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/token' responses: '200': description: Successfully retrieved change history for the given contact. content: application/json: schema: $ref: '#/components/schemas/contact-history-paginated-response' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contacts/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: Get Contact description: 'Get a single contact. When reading a contact, the following secure contact fields are only returned when also providing the `event/contacts:read-sensitive` scope: * socialSecurityNumber * passportNumber * nationalIdentificationNumber * dateOfBirth' operationId: getContactById security: - OAuth2.clientCredentials: - event/contacts:read - OAuth2.authorizationCode: - event/contacts:read tags: - Contacts responses: '200': description: Successfully retrieved a contact. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact' '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' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' put: security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write summary: Update Contact description: 'Updates a contact based on contact ID and the values provided in the request body. If you''re changing de-duplication fields, the new values must be unique in your account. When writing a contact, the following secure contact fields are only written when also providing the `event/contacts:write-sensitive` scope: * socialSecurityNumber * passportNumber * nationalIdentificationNumber * dateOfBirth' operationId: updateContactById tags: - Contacts requestBody: description: Contact to be updated required: true content: application/json: schema: $ref: '#/components/schemas/contact-update' responses: '200': description: Successfully updated the contact. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' patch: security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write summary: Patch Contact description: 'Updates a part of a contact based on the given contactId. To update a field, pass the value to be updated. To delete a field, set the field to null. Fields not passed in the request body will remain unchanged. For information on updating secure contact fields, see the description of PUT Contact.' operationId: patchContactById tags: - Contacts requestBody: description: Contact to be updated required: true content: application/json: schema: $ref: '#/components/schemas/contact-patch' responses: '200': description: Successfully updated the contact. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' delete: summary: Delete Contact description: Deletes a contact from the address book but does not remove the contact from events. security: - OAuth2.clientCredentials: - event/contacts:delete - OAuth2.authorizationCode: - event/contacts:delete operationId: deleteContactById tags: - Contacts responses: '204': description: Successfully deleted the contact. headers: {} '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '409': $ref: '#/components/responses/Conflict1' '429': $ref: '#/components/responses/TooManyRequests1' /contacts/{id}/custom-fields/{customFieldId}/answers: parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/customFieldId' put: summary: Update Custom Field Answers description: Update custom field answers for a single custom field and single contact operationId: updateContactCustomFieldAnswers security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write tags: - Contacts requestBody: description: "Custom Field answers to be updated. Answer values must be formatted correctly for a given Custom Field. The available fields and their supported formats are listed below.\n* **Open Ended Text - Date/Time**. This field type has several possible user-selected answer formats:\n - Date/Time (2022-01-01T12:00:00Z). Denoted by *DateTime* in the response payload. Milliseconds are truncated.\n - Date (2022-01-01). Denoted by *Date* in the response payload.\n* **Open Ended Text - One Line**. This field type has several possible user-selected answer formats:\n - General (Text). Denoted by *General* in the response payload.\n - Number (Whole numbers, 10, -10). Denoted by *Number* in the response payload.\n - Currency (Positive decimal value, 10.5). Denoted by *Currency* in the response payload.\n - Decimal (-20.5). Denoted by *Decimal* in the response payload.\n - US Phone Number (123-456-7890). Denoted by *USPhoneNumber* in the response payload.\n - Email Address (h.potterfield@test.com). Denoted by *Email* in the response payload.\n* **Open Ended Text - Comment Box**. Answer format is free-text (any value). Denoted by *FreeText* in the\n response payload.\n* **Choice - Single Answer (Drop-Down, Vertical, Horizontal).** Answer format is exactly one response to a\n list of user-defined choices. Denoted by *SingleSelect* in the response payload.\n* **Choice - Multiple Answers (Multi-Select Box, Vertical, Horizontal).** Answer format is one or more\n responses from a list of user-defined choices. Denoted by *MultiSelect* in the response payload.\n\nTo delete a Custom Field Answer, send an empty list of answers for a given Custom Field ID.\n" required: true content: application/json: schema: $ref: '#/components/schemas/custom-field' responses: '200': description: Successfully updated custom field answers for a contact headers: {} content: application/json: schema: $ref: '#/components/schemas/custom-field' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contacts/{id}/merge: parameters: - $ref: '#/components/parameters/id' post: requestBody: description: "Merge the 'main' contact with one or two other 'secondary' contacts. By default, the main contact's values will be used for the merged contact if present. Otherwise, the secondary contact's value is used. For contact memberships and contact profile image, only the main contact's data is used.\n\nWhen merging contacts that contain secure fields, the `event/contacts:write-sensitive` scope is required.\n\n**Conflict Resolution**\n\n* **contactFields**: A conflict arises for a contact field if it is empty in the main contact, two secondary contacts are provided, and both secondary contacts have values for the field.\n - You must provide the fieldName of the conflicted field and the ID of the contact whose value is to be kept to continue with the merge.\n - This array can also be used to override the default behavior and choose which contact to pull values from for each contact field.\n - The following contact fields are supported:\n - `sourceId`\n - `firstName`\n - `lastName`\n - `prefix`\n - `email`\n - `ccEmail`\n - `company`\n - `type.id`\n - `nickname`\n - `title`\n - `workPhone`\n - `middleName`\n - `mobilePhone`\n - `gender`\n - `npi`\n - `homeFax`\n - `designation`\n - `homePhone`\n - `pager`\n - `workFax`\n - `lastModifiedBy`\n - `lastModified`\n - `created`\n - `createdBy`\n - `workAddress` (for address fields, the full address of work or home are taken all together from a given contact)\n - `homeAddress`\n - `deleted`\n - `optOut.date`\n - `_links.linkedInUrl`\n - `_links.facebookUrl`\n - `_links.twitterUrl`\n - `customField.{uuid of custom field}`\n* **events**: A conflict arises for an event if it contains attendees associated with at least two of the provided contacts.\n - You must provide the ID of the conflicted event and the ID of the contact whose attendee is to be associated with the merged contact to continue with the merge.\n - Attendees with a 'No Response' or 'Visited' status whose linked contacts are not chosen in this step will be deleted. Attendees with other statuses will be kept but will be associated with an inactive contact.\n\n* **surveys**: A conflict arises for a survey containing respondents associated with at least two of the provided contacts.\n - You must provide the ID of the conflicted survey and the ID of the contact whose respondent will be associated with the merged contact to continue with the merge.\n - Respondents with a 'No Response' or 'Visited' status whose linked contacts are not chosen in this step will be deleted. Respondents with other statuses will be kept but will be associated with an inactive contact.\n - Only legacy surveys support merge functionality at this time.\n* **contactRelationships**: By default, the main contact's relationships are carried over to the merged contact, and those of the other contact(s) are discarded. This is the default regardless of whether the main contact has relationships or not.\n - You can provide a secondary contact's ID to carry over its relationships instead of the main contact. Only one contact's relationships can be carried over.\n" required: true content: application/json: schema: $ref: '#/components/schemas/contact-merge' security: - OAuth2.clientCredentials: - event/contacts:write - event/contacts:write-sensitive - OAuth2.authorizationCode: - event/contacts:write - event/contacts:write-sensitive summary: Merge Contacts description: Merges two or three contacts into a single contact. operationId: mergeContacts tags: - Contacts responses: '200': description: The successfully merged contact. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '409': $ref: '#/components/responses/Conflict1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contacts/{id}/obfuscate: parameters: - $ref: '#/components/parameters/id' post: security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write summary: Obfuscate a Contact description: 'Initiate obfuscation of a contact based on the given ID. Verify the status of the obfuscation using Get Obfuscation Status. Once this process succeeds, all the data for the contact will be obfuscated and will no longer be retrievable. See the Obfuscation User Guide for more details.' operationId: obfuscateContactById tags: - Contacts responses: '202': description: Successfully initiated obfuscation of the contact. Check the contact's obfuscation status. headers: Location: example: /contacts/obfuscate/9463c74e-18c6-401a-a710-ae0f485bf059/status description: This is the location to check the status of the obfuscation of the contact. schema: type: string format: uri content: application/json: schema: $ref: '#/components/schemas/contact-obfuscation-status' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '409': $ref: '#/components/responses/Conflict1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contacts/{id}/profile-images: parameters: - $ref: '#/components/parameters/id' delete: security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write summary: Delete Contact Profile Picture description: Deletes the profile picture of the given contact. operationId: deleteContactProfileImage tags: - Contacts responses: '204': description: Successfully deleted the profile picture of the contact. headers: {} '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' put: security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write summary: Assign Contact Profile Picture description: Assign a profile picture to a contact with a file UUID from file upload endpoint. This will replace the current profile picture if one is assigned. operationId: assignContactProfileImage requestBody: description: 'The file ID provided by the file upload endpoint. ' required: true content: application/json: schema: $ref: '#/components/schemas/contact-file' tags: - Contacts responses: '200': description: Successfully added the profile picture to the contact. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-file' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contacts/{id}/related-contacts: parameters: - $ref: '#/components/parameters/id' get: security: - OAuth2.clientCredentials: - event/contacts:read - OAuth2.authorizationCode: - event/contacts:read summary: Get Related Contact Ids description: Get all contact Ids related to the provided contact. operationId: getContactRelationshipsById tags: - Contacts parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/token' responses: '200': description: Successfully retrieved paginated list of Contact relationships. headers: {} content: application/json: schema: $ref: '#/components/schemas/contact-id-paginated-response' '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' deprecated: false externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' /contacts/{id}/related-contacts/{relatedContactId}: parameters: - $ref: '#/components/parameters/id' - $ref: '#/components/parameters/relatedContactId' put: security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write summary: Add Contact Relationship description: Adds a single contact relationship between the two contact Ids provided. operationId: createContactRelationship tags: - Contacts responses: '204': description: Successfully created a Contact relationship. headers: {} '400': $ref: '#/components/responses/BadRequest1' '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' delete: security: - OAuth2.clientCredentials: - event/contacts:write - OAuth2.authorizationCode: - event/contacts:write summary: Delete Contact Relationship description: Deletes a single contact relationship between the two contact Ids provided. operationId: deleteContactRelationship tags: - Contacts responses: '204': description: Successfully deleted a Contact relationship. headers: {} '401': $ref: '#/components/responses/Unauthorized1' '403': $ref: '#/components/responses/Forbidden1' '404': $ref: '#/components/responses/NotFound1' '429': $ref: '#/components/responses/TooManyRequests1' externalDocs: description: More about OAuth2 authorization code support for administrators url: '#oauth2-auth-code-planner-admin' components: schemas: contact: title: ExistingContact description: Represents a contact that has been created and has an id. type: object allOf: - $ref: '#/components/schemas/Contact' properties: id: type: string format: uuid description: The ID of the contact. parentId: type: string format: uuid description: ID of the parent contact, applicable with contact snapshot. readOnly: true event: description: Event ID type: object properties: id: type: string format: uuid description: ID of the event where the contact was created, applicable when contact snapshot is enabled for an event. readOnly: true Compliance: title: Compliance description: Privacy compliance fields for a contact. type: object properties: creationTime: type: string format: date-time description: Date-time (in GMT) when privacy compliance details were created for the contact. example: '2021-03-08T17:30:01.727Z' complianceScope: type: string description: Scope of privacy compliance. example: CCPA enum: - CCPA action: type: string description: Action to take for a compliance request. example: DO_NOT_SELL enum: - DO_NOT_SELL - OK_TO_SELL createdBy: type: string description: Denotes how the compliance request was created. example: PLANNER enum: - ATTENDEE - PLANNER - IMPORT - SOAP_API - REST_API - MARKETO - SALEFORCE - VIDEO_CENTER_MEMBER - RESPONDENT - NOT_SET 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 ContactMembership: title: ContactMembership description: Contact Membership information type: object readOnly: true properties: type: type: string description: The type of membership the contact has signed up for. maxLength: 300 example: Corporate Sponsor plan: type: string description: Describes the specific plan the contact has signed up for. maxLength: 300 example: Gold Level joined: type: string format: date description: The ISO-8601 formatted date the contact began their membership. readOnly: true example: '2017-02-10' expiration: type: string format: date description: The ISO-8601 formatted date the contact's membership will expire. readOnly: true example: '2020-02-09' lastRenewal: type: string format: date description: The ISO-8601 formatted date the contact last renewed their membership. readOnly: true example: '2019-02-08' amountDue: type: number description: The amount currently due for this membership. readOnly: true minimum: 0 example: 50.5 listInDirectory: type: boolean description: Indicates if the member details should be included in the member directory. example: false ContactOptOut: title: ContactOptOut description: Details of an opt-out for a Contact. type: object properties: optedOut: type: boolean default: false description: Used to denote if a contact has opted-out of receiving system generated emails. example: false date: type: string format: date-time description: The ISO 8601 zoned date time when this contact was opted-out. This value can change if the contact opts out multiple times. readOnly: true example: '2019-02-12T03:00:00Z' by: $ref: '#/components/schemas/OptoutBy' uuid-property: title: UUID Property description: A string that has to be a format matching the industry standard uuid type: string format: uuid example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3 filter: title: A filter sent in the body of a request description: A filter which is sent through the body of the request. type: object properties: filter: type: string example: property eq 'value' description: Filter included in the request. Contact: title: Contact description: Represents a contact and their related information. type: object allOf: - $ref: '#/components/schemas/Audit' properties: firstName: type: string description: The first name of the contact. maxLength: 30 example: Henry lastName: type: string description: The last name of the contact. maxLength: 50 example: Potterfield middleName: type: string description: The middle name of the contact. maxLength: 30 example: A nickname: type: string description: The nickname of the contact. maxLength: 30 example: Harry email: type: string format: email description: The email address of the contact. minLength: 6 maxLength: 80 example: h.potterfield@test.com ccEmail: type: string format: email description: An alternate email address of the contact that can be cc'd on email communications. minLength: 6 maxLength: 80 example: h.porter@tesing.com gender: $ref: '#/components/schemas/Gender' company: type: string description: The company/organization the contact belongs to. maxLength: 100 example: Cvent Inc. designation: type: string description: The designation of the contact, typically an award or credential. maxLength: 30 example: CPA title: type: string description: The job title of the contact. maxLength: 100 example: Event Planner type: $ref: '#/components/schemas/AttendeeContactType' membership: $ref: '#/components/schemas/ContactMembership' primaryAddressType: $ref: '#/components/schemas/AddressType' homeAddress: $ref: '#/components/schemas/Address' homePhone: type: string description: The phone number of the contact at their place of residence. maxLength: 30 example: 555-555-5555 homeFax: type: string description: The fax number of the contact at their place of residence. maxLength: 30 example: 555-555-5555 workAddress: $ref: '#/components/schemas/Address' workPhone: type: string description: The phone number of the contact at their place of work. maxLength: 30 example: 555-555-5555 workFax: type: string description: The fax number of the contact at their place of work. maxLength: 30 example: 555-555-5555 customFields: type: array items: $ref: '#/components/schemas/custom-field' description: Collection of custom fields. readOnly: true sourceId: description: 'This is a ID for the contact in an external system. NOTE: This value is expected to be unique for each contact within an account. Consider adding the external system name as part of the ID.' type: string maxLength: 50 example: system-a-00000000-0000-0000-0000-000000000000 mobilePhone: type: string description: The contact's mobile phone number. maxLength: 30 example: 555-555-5555 compliance: type: array items: $ref: '#/components/schemas/Compliance' description: Detail related to compliance with the contact's privacy rights under various legislation. readOnly: true prefix: type: string description: Denotes what is traditionally a title of an individual. maxLength: 30 example: Mr. pager: type: string description: The pager number of the contact. maxLength: 30 example: 555-555-5555 deleted: type: boolean description: True indicates a contact is deleted. Deleted contacts still have their data retained, but the contact is inactive. default: false example: false readOnly: true purged: type: boolean description: True indicates a contact is purged. Purged contacts have only partial data retained, and will be permanently deleted in 30 days. default: false example: false readOnly: true optOut: $ref: '#/components/schemas/ContactOptOut' npi: type: string description: Unique 10-digit identification number issued by the Centers for Medicare and Medicaid Services for health care providers in the United States. minLength: 10 maxLength: 10 example: '5555555555' _links: $ref: '#/components/schemas/ContactLinks' dateOfBirth: type: string format: date description: "The date of birth of the contact.\n\n Reading and writing of this field require the `event/contacts:read-sensitive` and `event/contacts:write-sensitive` scopes respectively." example: '1990-01-01' passportNumber: type: string description: "The passport number of the contact.\n\n Reading and writing of this field require the `event/contacts:read-sensitive` and `event/contacts:write-sensitive` scopes respectively. This field has been deprecated. Instead, use the passport.number field." example: '123456789' maxLength: 100 deprecated: true passport: $ref: '#/components/schemas/Passport' socialSecurityNumber: type: string description: "The social security number of the contact.\n\n Reading and writing of this field require the `event/contacts:read-sensitive` and `event/contacts:write-sensitive` scopes respectively." example: 123-45-6789 maxLength: 11 nationalIdentificationNumber: type: string example: '123456789' description: "The national identification number of the contact.\n\n Reading and writing of this field require the `event/contacts:read-sensitive` and `event/contacts:write-sensitive` scopes respectively." maxLength: 25 headline: type: string description: The headline of the contact's profile, which summarizes their professional experience and qualities. example: Marketing Director Crafting Memorable Campaigns that Engage Audiences and Elevate Brands maxLength: 2500 personalWebsite: type: string description: A contact's personal website URL. format: uri example: https://www.example.com maxLength: 2500 biography: type: string description: A contact's biographical writeup. example: I am a marketing professional with experience in event planning and brand strategy. maxLength: 2500 pronouns: type: string description: Represents the preferred pronouns of a contact. example: he/him/she/her/they/them maxLength: 50 ContactId: title: ContactId description: A contact id. required: - id type: object properties: id: type: string format: uuid description: The ID of the contact. ContactLinks: title: ContactLinks type: object description: Collection of social media links for the contact. properties: twitterUrl: $ref: '#/components/schemas/Link' facebookUrl: $ref: '#/components/schemas/Link' linkedInUrl: $ref: '#/components/schemas/Link' profilePicture: type: object description: Reference to a profile picture. title: Link required: - href readOnly: true properties: href: type: string description: The url of the contact's profile picture example: https://cvent.com/picture123 DistributionListStatus: title: DistributionListStatus enum: - PENDING - PROCESSING - COMPLETE type: string description: Type of distribution list status. readOnly: true example: PENDING CustomFieldType: title: CustomFieldType enum: - AutoIncrement - ConsentQuestion - Currency - Decimal - Date - DateTime - Email - FileUpload - FreeText - General - MultiChoice - MultiSelect - Number - OpenEndedDateTime - OpenEndedText - SingleChoice - SingleSelect - USPhoneNumber - Unknown type: string description: The type of data collected by a custom field. example: General EventContactId: title: EventContactId description: A pair of event and contact id. required: - eventId - contactId type: object properties: eventId: type: string format: uuid description: ID of the event. contactId: type: string format: uuid description: ID of the contact. custom-field: title: CustomField description: A Custom Field type: object allOf: - $ref: '#/components/schemas/CustomFieldBase' properties: type: description: The type of data collected by a custom field. type: string allOf: - $ref: '#/components/schemas/CustomFieldType' - readOnly: true example: MultiSelect contact-patch: title: ContactPatch description: This entity is used to represent a single item that is requested for a contact patch. required: - id allOf: - $ref: '#/components/schemas/contact' - properties: company: {} title: {} _links: properties: facebookUrl: properties: href: {} homeAddress: properties: address3: {} countryCode: {} dateOfBirth: {} gender: {} homePhone: {} socialSecurityNumber: {} DistributionListSecurityType: title: DistributionListSecurityType enum: - PRIVATE - SEMI_PRIVATE - PUBLIC type: string description: Type of distribution list security. For a public list, contacts can sign up themselves. For a semi-private list, contacts can add themselves, but a planner must approve their membership before they can receive emails. For a private list, only planners can add contacts. Contacts can always remove themselves from lists on the Manage Profile page. contact-paginated-response: title: ContactPaginatedResponse description: The response from a request to get the list of contacts. This includes the paging object as well as the collection of contacts. required: - paging - data type: object properties: paging: $ref: '#/components/schemas/Paging' data: type: array items: $ref: '#/components/schemas/contact' description: Collection of contacts. UpdatedThroughNameProperty: title: UpdatedThroughNameProperty description: Name of the place where this change was updated through. type: string enum: - Abstract Guest Side Author Update - Abstract Guest Side Reviewer Update - Abstract Guest Side User - Abstract Planner side - Address Book Profile - Amex Card Delete - Amex Card Insert - Amex Card Update - Answers Replaced from Administration - Appointment Guest Side - Attendee Hub - Budget Allocation Update - Budget Attendee Update - Budget Item Custom Field Answers Replaced from Administration - Budget Item Delete - Budget Item Duplicate - Budget Item Import - Budget Item Insert via REST API - Budget Item Insert - Budget Item Single Update - Budget Item Template Import - Budget Item Update via REST API - Budget Items Bulk Assign Vendor - Budget Items Bulk Copy Cost label - Budget Items Bulk Copy - Budget Items Bulk Delete - Budget Items Bulk Update - Budget Version Update - Bulk Update Contact Field Answer - Concur Reconciliation - Create New Budget Item For Each Expense - Concur Reconciliation - Map to Existing Budget Item - Confirm Opt In Email - Contact Import - Contact New Membership - Contact Pending Obfuscation - Contact Website Profile Update - Created Within Meeting Request - Created from API - Created from Request Website - Crowd Compass Profile Update - Custom Field Added From Admin - Custom Field Added via REST API - Custom Field Deleted From Admin - Custom Field Modified From Admin - Custom Field Modified via REST API - Deleted Within Administration - Deleted from Meeting Request Form - Deleted from Request Website - Deleted within Meeting Request - Event Automatically Created from Meeting Request - Event Created from API - Event Created from Event Wizard - Event Guest Side Modification - Event Guest Side Registration - Event Import - Event Modified from Meeting Request via API - Event Modified from Meeting Request - Event Onsite Registration - Event POST - Event Planner Contact Information Update - Event Planner Side Modification - Event Planner Side Registration - Hotel Request Import - Marketo Contact Import - Modified Within Event - Modified Within Meeting Request - Modified from API - Modified from Event Documents - Modified from Meeting Request via Notification - Modified from Request Website - Registration Import - REST API - Salesforce Integration - Survey Author Modification - Survey Author Response - Survey Guest Side Modification - Survey Guest Side Response - Survey POST - Travel Cost Import - Map to Existing Budget item - Travel Cost Import - Map to New Budget Item - VCN Transaction - Create New Budget Item For Each Transaction - VCN Transaction - Map to Multiple Budget Item - VCN Transaction - Map to Single Budget Item - VCN Transaction - Removed from Budget Item - Web Services - eMarketing Profile Update example: Address Book Profile Address: title: Address description: Contact address details. type: object allOf: - $ref: '#/components/schemas/BaseAddress' properties: region: type: string description: The name of the state/province/region of the address. readOnly: true example: Texas regionCode: type: string description: The abbreviation of the state/province/region of the address. minLength: 2 maxLength: 10 example: TX country: type: string description: Name of the country of the address. readOnly: true example: United States of America ContactHistory: title: ContactHistory description: A single instance of change for a specific contact in the contact's change history. type: object properties: updatedFieldName: description: The name of a field that was changed and tracked by this single instance of change in contact change history. type: string example: Last Name oldValue: description: The old value of a field that was changed. type: string example: Wilson newValue: description: The new value of a field that was changed. type: string example: James updatedThroughName: $ref: '#/components/schemas/UpdatedThroughNameProperty' updatedDate: description: The ISO 8601 formatted date-time when the associated contact, of this single instance of change in contact change history, was updated. type: string format: date-time example: '2023-08-03T14:51:00.777Z' updatedBy: description: The name of a person who updated a contact that is associated with this single instance of change in contact change history. type: string example: John Doe BaseAddress: title: Base Address description: Base Address Model type: object properties: address1: type: string maxLength: 40 description: The first line of an address. example: Cvent Inc. address2: type: string maxLength: 40 description: The second line of an address. example: 4001 West Parmer Lane address3: type: string maxLength: 40 description: The third line of an address. example: PO Box 123 city: type: string maxLength: 40 description: The name of the city. example: Austin countryCode: type: string maxLength: 3 minLength: 2 description: ISO 3166 two-letter (alpha-2) country code. example: US postalCode: type: string maxLength: 25 description: Postal code (also known as zipcode) of the address. example: '78727' ContactType: title: ContactType description: This entity represents a contact type at contact level. required: - id - code - name type: object properties: id: type: string format: uuid description: The ID of the contact type. readOnly: true code: type: string description: The contact type code. Must be unique in the account. readOnly: true maxLength: 30 example: VIP name: type: string description: Name of the contact type. maxLength: 50 example: VIP Attendee description: type: string description: Description of the contact type. maxLength: 2500 example: Very important attendee. active: type: boolean description: Indicates whether the contact type is active. example: true readOnly: true 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. contact-merge: title: ContactMergeRequest description: This entity represents a request to merge one or two contacts with another 'main' contact. required: - secondaryContacts properties: secondaryContacts: type: array items: $ref: '#/components/schemas/uuid-property' minItems: 1 maxItems: 2 description: Id of the contact(s) to be merged to the main contact. conflictResolution: type: object description: Represents choices in resolving conflicts in the contacts to be merged or to optionally select fields to keep from a secondary contact, overriding default behavior. properties: events: type: array items: $ref: '#/components/schemas/EventContactId' description: For each event (designated by event id), choose a contact id whose linked attendee will be associated with the resulting merged contact. Use whenever at least two contacts exist as attendees in a single event. surveys: type: array items: $ref: '#/components/schemas/SurveyContactId' description: For each survey (designated by survey id), choose a contact id whose linked respondent will be associated with the resulting merged contact. Use whenever at least two contacts exist as respondents in a single survey. relatedContacts: type: string format: uuid description: The id of the contact to keep the relationships of in the resulting merged contact. Only one contact can be chosen, and relationships of the other contact(s) will be discarded. contactFields: type: array items: $ref: '#/components/schemas/ContactMergeField' description: Specify which contact to use values from for any contact field. contact-id-paginated-response: title: ContactIdPaginatedResponse description: The response from a request to get the ids of contacts in a contact group or relationship. This includes the paging object as well as the collection of contact ids. required: - paging - data type: object properties: paging: $ref: '#/components/schemas/Paging' data: type: array items: $ref: '#/components/schemas/IdOnlyEntity' description: Collection of contact ids. contact-update: title: ContactUpdate description: This entity is used to represent a single item that is requested for a contact update required: - id allOf: - $ref: '#/components/schemas/contact' BulkResponseItem: title: BulkResponseItem description: Represents a single item that is returned as part of a Bulk request call. type: object required: - status - data properties: data: type: object description: The data returned for a single item in the bulk request call. example: event_id: 1234 attendee_count: 50 additionalProperties: true status: type: integer description: http status code representing processing status of a single item example: 400 message: type: string description: Quick description of what happened with processing example: Example error message. request: type: object description: The processed request tied to this response. This field is only sent when processing fails. example: operation: PUT headers: header1: header1Value header2: header2Value queryParams: param1: param1Value param2: param2Value additionalProperties: true additionalProperties: false contact-bulk-create: type: array items: $ref: '#/components/schemas/ContactCreate' Gender: title: Gender enum: - Male - Female - Non-binary - Rather not say type: string description: The gender of the contact. example: Male contact-obfuscation-status: title: ContactObfuscationStatus description: Model representing an obfuscation status of a contact. type: object properties: status: $ref: '#/components/schemas/ContactObfuscationStatusType' obfuscateId: type: string format: uuid description: The obfuscation job identifier. readOnly: true contact: $ref: '#/components/schemas/ContactId' contact-bulk-update: type: array items: $ref: '#/components/schemas/contact-update' ContactCreate: title: ContactCreate description: This entity is used to represent a single item that is posted for a contact create allOf: - $ref: '#/components/schemas/CreateContact' contact-bulk-patch: type: array items: $ref: '#/components/schemas/contact-patch' contact-type-paginated-response: title: ContactTypePaginatedResponse description: The response from a request to get the list of contact types. This includes the paging object as well as the collection of contact-types. required: - paging - data type: object properties: paging: $ref: '#/components/schemas/Paging' data: type: array items: $ref: '#/components/schemas/ContactType' description: Collection of contact types. DistributionListInfo: title: DistributionListInfo description: Model representing a distribution list info. Only required if the contact group type is DISTRIBUTION_LIST. type: object properties: securityType: $ref: '#/components/schemas/DistributionListSecurityType' internalNote: description: Internal note for Distribution Lists. type: string maxLength: 300 example: Sample distribution list internal note status: $ref: '#/components/schemas/DistributionListStatus' AddressType: title: AddressType enum: - Home - Work type: string description: The type of address. example: Home CustomFieldBase: title: CustomFieldBase description: Base schema for Custom Field - allows type to be customized by extending schemas required: - id - value type: object properties: id: type: string description: The unique ID representing this custom field. format: uuid name: type: string description: The actual text of the custom field. example: What is your favorite color? readOnly: true value: type: array uniqueItems: true items: type: string description: A question answer value maxLength: 16000 description: The set of answers or possible answers to a question. example: - Choice C - Choice A order: type: integer description: The order of this question in the bigger list of questions. example: 1 readOnly: true SurveyContactId: title: SurveyContactId description: A pair of survey and contact id. required: - surveyId - contactId type: object properties: surveyId: type: string format: uuid description: ID of the survey contactId: type: string format: uuid description: ID of the contact contact-bulk-response: title: ContactBulkResponse description: List of contacts to create or update. type: array items: $ref: '#/components/schemas/ContactBulkResponseItem' contact-history-paginated-response: title: ContactHistoryPaginatedResponse description: The response of a request to get the change history for a specific contact. type: object properties: paging: $ref: '#/components/schemas/Paging' data: description: Collection of change histories for a specific contact. type: array items: $ref: '#/components/schemas/ContactHistory' CreateContact: title: CreateContact description: Represents a contact to be created. type: object allOf: - $ref: '#/components/schemas/Contact' properties: parentId: deprecated: true type: string format: uuid description: ID of the parent contact, applicable with contact snapshot. This field has been deprecated. If the event has contact snapshot enabled, snapshot will be automatically created through the Add attendees API. event: deprecated: true description: Event ID type: object properties: id: deprecated: true type: string format: uuid description: ID of the event where the contact was created, applicable when contact snapshot is enabled for an event. This field has been deprecated. If the event has contact snapshot enabled, snapshot will be automatically created through the Add attendees API. 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 OptoutBy: title: OptoutBy enum: - Abuse Complaint - Account User - API - Contact Self Opt-Out - Cvent Support - Hard Bounce - Import - Invitee Self Unsubscribe - Multiple Bounce - Respondent Self Unsubscribe - Temporary Block - Cvent Salesforce App type: string description: This is used to denote how a contact is opt'd out of Cvent system. example: Account User readOnly: true 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 contact-group-paginated-response: title: ContactGroupPaginatedResponse description: The response from a request to get the list of contact groups. This includes the paging object as well as the collection of contact-groups. required: - paging - data type: object properties: paging: $ref: '#/components/schemas/Paging' data: type: array items: $ref: '#/components/schemas/contact-group' description: Collection of contact groups. ContactMergeField: title: ContactMergeField description: A pair of a contact field name and a contact id. required: - fieldName - contactId type: object properties: fieldName: type: string example: firstName description: The name of a contact field. contactId: type: string format: uuid description: ID of the contact. example: a45a3341-d30f-4bd9-bfd8-fbcdae37f0f2 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' ContactBulkResponseItem: title: ContactBulkResponseItem description: This entity is used to represent a single item that is returned as part of a Bulk request call. allOf: - $ref: '#/components/schemas/BulkResponseItem' properties: data: anyOf: - $ref: '#/components/schemas/contact' - $ref: '#/components/schemas/ErrorResponse-12' contact-group: title: ContactGroup required: - id - name description: A group of contacts. allOf: - $ref: '#/components/schemas/Audit' type: object properties: id: type: string format: uuid description: The ID of the contact group. readOnly: true name: type: string description: Name of the contact group. maxLength: 100 example: group name shortDescription: type: string description: Short description of the contact group. example: short description description: type: string description: Full description of the contact group. example: long description type: $ref: '#/components/schemas/ContactGroupType' note: deprecated: true type: string description: Moved to internalNote in the DistributionListInfo object. The note field only applies to Distribution List. example: Sample internal note distributionListInfo: $ref: '#/components/schemas/DistributionListInfo' ContactGroupType: title: ContactGroupType enum: - BLACKLIST - DISTRIBUTION_LIST - STANDARD type: string description: Type of contact group. `BLACKLIST` are contacts that are not allowed to register for your events. `DISTRIBUTION_LIST` is a group of contacts you plan to send eMarketing emails to. `STANDARD` is a multi-purpose group for organizing contacts. example: STANDARD default: STANDARD ContactObfuscationStatusType: title: ContactObfuscationStatusType enum: - INITIATED - QUEUED - PROCESSING - COMPLETED - FAILED type: string description: 'Status of the request to obfuscate a contact. INITIATED - The obfuscation request has been received. QUEUED - The obfuscation request is currently waiting in the queue to be executed. PROCESSING - The obfuscation request is currently being processed. COMPLETED - The obfuscation request is complete. FAILED - The obfuscation request failed due to an error.' example: INITIATED Passport: title: Passport description: This entity represents a contact's passport information. type: object properties: number: type: string description: "The passport number of the contact.\n\n Reading and writing of this field require the `event/contacts:read-sensitive` and `event/contacts:write-sensitive` scopes respectively." example: '123456789' maxLength: 100 country: type: string description: The passport country of the contact. example: United Kingdom readOnly: true countryCode: type: string description: The passport country code of the contact. example: GB minLength: 2 maxLength: 3 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' AttendeeContactType: title: AttendeeContactType type: object description: Contains details related to the attendee's contact type. properties: id: type: string format: uuid description: The unique identifier of the contact type example: 861B51EC-AA7E-475F-B38D-4C8E35C47D63 name: type: string description: A descriptive name for the contact type example: VIP Member readOnly: true IdOnlyEntity: title: Id only entity description: An entity which only has an id. required: - id type: object properties: id: type: string description: The entity's id value. example: abc-123 contact-file: title: ContactFile required: - file - href description: A contact's file, such as a profile image. properties: file: properties: id: type: string format: uuid description: The ID of the file. href: format: uri type: string description: URL of the contact's file. readOnly: true example: https://custom.cvent.com/a5154f85f71a4cf2464e037feb75b308/00000000000000000000000000000000/files/universal-file/tmp/e209d73d845746b7a6deda4da9d91b2c.png parameters: before: name: before required: false in: query description: Used to query records that have been added or updated before this time point. schema: type: string format: date-time example: '2017-01-02T02:00:00Z' id: in: path name: id description: ID of a contact. required: true schema: $ref: '#/components/schemas/uuid-property' obfuscateId: in: path name: obfuscateId description: ID of an obfuscation request. required: true schema: $ref: '#/components/schemas/uuid-property' after: name: after required: false description: Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store. in: query schema: type: string format: date-time example: '2017-01-02T02:00:00Z' 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 includePurged: in: query required: false name: includePurged description: 'True means purged contacts can be included in the response. Purged contacts contain only limited display data (`id`, `lastModified`, and `purged`). When true, the filter query parameter can only filter by the `id` field. The `before`, `after`, `limit`, and `token` query parameters are still valid query parameters to use with this parameter. If false, only contacts that have not been purged will be returned. ' schema: type: boolean default: false customFieldId: in: path name: customFieldId description: ID of a custom field. required: true schema: $ref: '#/components/schemas/uuid-property' relatedContactId: in: path name: relatedContactId description: ID of a related contact. required: true schema: $ref: '#/components/schemas/uuid-property' 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 contactGroupId: in: path name: id description: ID of a contact group. required: true schema: $ref: '#/components/schemas/uuid-property' contactId: in: path name: contactId description: ID of a contact. required: true schema: $ref: '#/components/schemas/uuid-property' responses: 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 TooManyRequests1: description: Too many requests content: application/json: schema: $ref: '#/components/schemas/ErrorResponse-12' example: code: 429 message: Limit Exceeded NotFound1: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse-12' example: code: 404 message: Not found Unauthorized1: description: Bad or expired token content: application/json: schema: $ref: '#/components/schemas/ErrorResponse-12' example: code: 401 message: Unauthorized BadRequest1: description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse-12' example: code: 400 message: Bad Request Conflict1: description: The request conflicts with current state of the target resource content: application/json: schema: $ref: '#/components/schemas/ErrorResponse-12' example: code: 409 message: Conflict securitySchemes: 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. 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. CallbackApiKeyAuth: type: apiKey in: header name: Authorization description: This security scheme is used to indicate that Cvent should use API Key auth when invoking your callback. This scheme is only supported for callback operations, and cannot be used to make calls to Cvent endpoints. CallbackBasicAuth: type: http scheme: basic description: This security scheme is used to indicate that Cvent should use basic auth when invoking your callback. This scheme is only supported for callback operations, and cannot be used to make calls to Cvent endpoints. externalDocs: description: Cvent Developer Documentation url: https://developers.cvent.com/docs