{ "opencollection": "1.0.0", "info": { "name": "Cvent REST APIs — Event Cloud Discounts API", "version": "ea" }, "items": [ { "info": { "name": "Discounts", "type": "folder" }, "items": [ { "info": { "name": "List Event Discounts", "type": "http" }, "http": { "method": "GET", "url": "https://api-platform.cvent.com/ea/events/:id/discounts", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID of an event." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records to return per page." }, { "name": "token", "value": "", "type": "query", "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n" }, { "name": "sort", "value": "", "type": "query", "description": "The sort order passed as a parameter, used to control the order of the\nsearch results as a priority ordered list of sorts.\n\nThere are two orders:\n * ascending: ASC\n * descending: DESC\n\nThe following fields are sortable:\n * name\n * code\n * method.type\n * effectiveTo\n * effectiveFrom\n * type\n * level\n" }, { "name": "filter", "value": "", "type": "query", "description": "Use filter query parameters to limit results\nto data that matches your criteria. See\n[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.\n\nSupported fields and operators are listed below:\n\n| Field | Operators |\n|------------------|-------------------------------------|\n| id | `in` |\n| method.type | `eq` |\n| type | `eq` |\n| level | `eq` |\n\nThe following logical operators are supported for combining filters:\n* and\n* or\n" }, { "name": "before", "value": "", "type": "query", "description": "Used to query records that have been added or updated before this time point." }, { "name": "after", "value": "", "type": "query", "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." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a paginated list of all discounts used in an event, including both event-specific and account-level discount codes used in an event.\n" }, { "info": { "name": "Create Event Discount", "type": "http" }, "http": { "method": "POST", "url": "https://api-platform.cvent.com/ea/events/:id/discounts", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID of an event." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create discount in an event.\n" }, { "info": { "name": "List Discounted Agenda Items", "type": "http" }, "http": { "method": "GET", "url": "https://api-platform.cvent.com/ea/events/:id/discounts/agenda-items", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID of an event." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records to return per page." }, { "name": "token", "value": "", "type": "query", "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Use filter query parameters to limit results\nto data that matches your criteria. See\n[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.\n\nSupported fields and operators are listed below:\n\n| Field | Operators |\n|------------------|-------------------------------------|\n| discount.id | `eq`, `in` |\n| type | `eq`, `in` |\n\nThe following logical operators are supported for combining filters:\n* and\n* or\n" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a paginated list of agenda items that are associated with discounts for the specified event. This endpoint helps identify which agenda items (such as admission items, sessions, session bundles, membership-items or quantity-items) are currently associated with discounts.\n" }, { "info": { "name": "Update Event Discount", "type": "http" }, "http": { "method": "PUT", "url": "https://api-platform.cvent.com/ea/events/:id/discounts/:discountId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID of an event." }, { "name": "discountId", "value": "", "type": "path", "description": "Unique ID of a discount." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update a discount in an event based on details in the request body. Fields not included in the request will revert to their default value.\n" }, { "info": { "name": "Link Agenda Item to Discount", "type": "http" }, "http": { "method": "PUT", "url": "https://api-platform.cvent.com/ea/events/:id/discounts/:discountId/agenda-items/:agendaItemId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID of an event." }, { "name": "discountId", "value": "", "type": "path", "description": "Unique ID of a discount." }, { "name": "agendaItemId", "value": "", "type": "path", "description": "Unique ID of an agenda item." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Links an agenda item to a given event discount." }, { "info": { "name": "Unlink Agenda Item Discount", "type": "http" }, "http": { "method": "DELETE", "url": "https://api-platform.cvent.com/ea/events/:id/discounts/:discountId/agenda-items/:agendaItemId", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID of an event." }, { "name": "discountId", "value": "", "type": "path", "description": "Unique ID of a discount." }, { "name": "agendaItemId", "value": "", "type": "path", "description": "Unique ID of an agenda item." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Unlinks an agenda item from a given event discount." } ] } ], "bundled": true }