### Salesforce App Installation Link

Source: https://developers.cvent.com/docs/cvent-salesforce-app/app-installation

This snippet provides the base URL structure for installing the Cvent Salesforce App. It's used to append a specific package code for installation, particularly for My Domain specific URLs.

```text
/packaging/installPackage.apexp?p0=04tKf000000om0SIAQ
```

--------------------------------

### Jifflenow API Authentication - Client Credentials Grant

Source: https://developers.cvent.com/docs/legacy-api/jifflenow-api/getting-started

This section details how to obtain an access token using the Client Credentials Grant flow for machine-to-machine integrations.

```APIDOC
## POST /api/oauth/token

### Description
Requests an access token using the Client Credentials Grant flow. This is suitable for server-to-server integrations.

### Method
POST

### Endpoint
`https://<company>.jifflenow.com/api/oauth/token`

### Parameters
#### Request Body
- **grant_type** (string) - Required - Must be `client_credentials`.
- **client_id** (string) - Required - Your application's client ID.
- **client_secret** (string) - Required - Your application's client secret.

### Request Example
```curl
curl -X POST "https://<companyname>.jifflenow.com/api/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=CLIENT_ID" \
  -d "client_secret=CLIENT_SECRET"
```

### Response
#### Success Response (200)
- **access_token** (string) - The temporary token for making authorized API requests.
- **token_type** (string) - The type of token, typically "Bearer".
- **expires_in** (integer) - The token's lifetime in seconds (e.g., 1800 for 30 minutes).
- **scope** (string) - The level of access granted (e.g., "public").
- **created_at** (integer) - A UNIX timestamp indicating when the token was issued.

#### Response Example
```json
{
  "access_token": "Sa9e68z4xQgjCgh_rxTHmkrgM6BfATDqH3tZc2XJDF0",
  "token_type": "Bearer",
  "expires_in": 1800,
  "scope": "public",
  "created_at": 1739303158
}
```

### Usage
Include the access token in the `Authorization` header for subsequent API requests:
`Authorization: Bearer <ACCESS_TOKEN>`
```

--------------------------------

### White Label Instant Book Widget Deployment

Source: https://developers.cvent.com/docs/wl-ibk/deployment

Information on how to get started with the White Label Instant Book, including required information and the embed code structure.

```APIDOC
## Getting Started
To integrate with White Label Instant Book, please provide the following to your Cvent representative:

*   **Venue Information**: The specific venue you wish to integrate.
*   **Custom Branding (Optional)**: Your venue logo for display on the instant booking pages.
*   **Button Style**: Your preferred button style to match your website's branding.
```

--------------------------------

### CVENT API - Get RFP Response Body Example

Source: https://developers.cvent.com/docs/legacy-api/csn/supplier-guide/rfp-objects

Provides an example of the response body for an RFP request, detailing date modes and alternate date configurations.

```json
{
  "dateMode": "ALTERNATE_DATE",
  "datePatterns": [],
  "alternateDates": [
    {
      "id": "52D3397C-0A95-4429-9F4C-06E6C9F2A40A",
      "startDate": "2019-11-03",
      "endDate": "2019-11-07",
      "isPreferred": true
    },
    {
      "id": "18F135F1-A3C3-4281-AB33-3EF9C7243B10",
      "startDate": "2019-11-06",
      "endDate": "2019-11-10",
      "isPreferred": true
    },
    {
      "id": "F1C24074-2A40-4314-B9FC-804D69E3D0A5",
      "startDate": "2019-11-10",
      "endDate": "2019-11-14",
      "isPreferred": true
    },
    {
      "id": "D0D372B9-CFEF-41A8-B3B8-86102DD18F5F",
      "startDate": "2019-11-13",
      "endDate": "2019-11-17",
      "isPreferred": true
    },
    {
      "id": "6A14DDF7-E9F0-430B-AF44-D243DB88D60D",
      "startDate": "2019-11-17",
      "endDate": "2019-11-21",
      "isPreferred": true
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "startDate": "2019-11-20",
      "endDate": "2019-11-24",
      "isPreferred": true
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "startDate": "2019-11-24",
      "endDate": "2019-11-28",
      "isPreferred": true
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "startDate": "2019-11-27",
      "endDate": "2019-12-01",
      "isPreferred": true
    }
  ]
}
```

--------------------------------

### Request Access Token via Client Credentials Grant (curl)

Source: https://developers.cvent.com/docs/legacy-api/jifflenow-api/getting-started

This snippet demonstrates how to request an access token using the Client Credentials Grant flow via a cURL command. It includes the necessary endpoint, headers, and request parameters for authentication.

```curl
curl -X POST "https://<companyname>.jifflenow.com/api/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=CLIENT_ID" \
  -d "client_secret=CLIENT_SECRET"
```

--------------------------------

### Example Triggered Callback URL

Source: https://developers.cvent.com/docs/passkey/REST/callbacks

Illustrates a concrete example of a callback URL after the placeholder tags have been replaced with actual data. This shows how the dynamic URL appears when a callback is triggered.

```plaintext
http://www.myreg.com/newres.asp?eventid=146021&extacknum=48943548&bridge=3233XNZ2-G582&resacknum=328T24NB&status=0
```

--------------------------------

### Include Access Token in API Request Header

Source: https://developers.cvent.com/docs/legacy-api/jifflenow-api/getting-started

This shows the standard format for including the obtained access token in the 'Authorization' header of subsequent API requests to Jifflenow.

```http
Authorization: Bearer <ACCESS_TOKEN>
```

--------------------------------

### Shared Link Retrieval API Response Example

Source: https://developers.cvent.com/docs/legacy-api/jifflenow-api/misc/shared-link-retrieval

Example of a successful (200 OK) response from the Shared Link Retrieval API, containing a list of shared links and pagination details.

```json
{
  "status": 200,
  "message": "Request successful",
  "data": {
    "shared_links": [
      {
        "id": 1,
        "uuid": "3f3rmOohDHwRd40of7rrsw",
        "shared_from_date": "2025-04-06",
        "shared_to_date": "2025-04-06",
        "link_status": "Scheduled",
        "link_type": "Multi use",
        "meeting_with": "Test123",
        "meeting_type": "Product Demo",
        "topic": "5G",
        "expiredOn": "2025-06-06T23:59:59Z",
        "createdAt": "2025-06-03T12:00:00Z",
        "updatedAt": "2025-06-03T12:00:00Z",
        "timezone": "Europe/Madrid",
        "location": "Room",
        "vcon": "Zoom",
        "link": "https://example.jifflenow.com/emeet/test9/meeting-request/?token=QSPoGIlFfpsEtC94_snIi",
        "comments": "",
        "requestor": {
          "first_name": "Alen123",
          "last_name": "Ramana",
          "company_name": "Example Inc.",
          "email": "alen.jph@example.com",
          "title": "Sales Rep",
          "contact_no": "",
          "personal_link": "https://example.jifflenow.com/my/Alen123Ramana-Eg2UYx3T",
          "custom_fields": {
            "country": "India",
            "state": "Karnataka"
          },
          "consents": [
            {
              "consent_type": "standard",
              "verbiage": "sample verbiage text"
            }
          ]
        },
        "participants": [
          {
            "first_name": "John",
            "last_name": "Smith",
            "company_name": "Example",
            "email": "jsmith@example.com",
            "title": "Head of Sales",
            "contact_no": "",
            "user_type": "Internal",
            "createdAt": "2025-06-03T12:00:00Z",
            "updatedAt": "2025-06-03T12:00:00Z",
            "custom_fields": {
              "country": "India",
              "state": "Karnataka"
            },
            "consents": []
          },
          {
            "first_name": "Alen",
            "last_name": "Joseph",
            "company_name": "Example",
            "email": "alen.jph@example.com",
            "title": "",
            "contact_no": "",
            "user_type": "External",
            "createdAt": "2025-06-03T12:00:00Z",
            "updatedAt": "2025-06-03T12:00:00Z",
            "custom_fields": {
              "country": "India",
              "state": "Karnataka"
            },
            "consents": []
          }
        ]
      }
    ],
    "current_page": 1,
    "total_records": 100,
    "total_pages": 94
  }
}
```

--------------------------------

### List Contacts API Request (cURL)

Source: https://developers.cvent.com/docs/rest-api/tutorials/developer-quickstart

This cURL command demonstrates how to make a GET request to the Cvent API to list contacts. It requires the hostname and an access token for authorization, and the `contacts:read` scope must be assigned to the application.

```cURL
--location --request GET '{hostName}/ea/contacts' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {accessToken}'
```

--------------------------------

### Get Access Token

Source: https://developers.cvent.com/docs/rest-api/tutorials/developer-quickstart

This endpoint is used to request an access token using the client credentials flow for OAuth 2.0 authorization. You need to provide your client ID and client secret, base64 encoded.

```APIDOC
## POST /ea/oauth2/token

### Description
Requests an access token for OAuth 2.0 client credentials flow.

### Method
POST

### Endpoint
`{hostName}/ea/oauth2/token`

### Parameters
#### Header Parameters
- **Content-Type** (string) - Required - `application/x-www-form-urlencoded`
- **Authorization** (string) - Required - `Basic {YOUR_CLIENT_CREDENTIALS}` (Base64 encoded `client_id:client_secret`)

#### Request Body
- **grant_type** (string) - Required - `client_credentials`
- **client_id** (string) - Required - Your application's client ID

### Request Example
```bash
curl --location --request POST '{hostName}/ea/oauth2/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic {YOUR_CLIENT_CREDENTIALS}' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id={YOUR_CLIENT_ID}'
```

### Response
#### Success Response (200 OK)
- **access_token** (string) - The generated access token.
- **expires_in** (integer) - The token's lifetime in seconds (e.g., 3600).
- **token_type** (string) - The type of token, usually "Bearer".

#### Response Example
```json
{
  "access_token": "{accessToken}",
  "expires_in": 3600,
  "token_type": "Bearer"
}
```
```

--------------------------------

### White Label Widget API Deployment Example

Source: https://developers.cvent.com/docs/white-label/widget-api-deployment

This snippet demonstrates the basic implementation of the Cvent White Label Widget API. It includes setting up a container element and initializing the widget with essential options like display mode, container ID, widget identifier, API key, and property UID.

```html
<!-- Provide an empty container as the content will be overwritten by the widget -->
<div id="wlrfp-container"></div>
```

```javascript
var options = {
  display: "window",
  container: "wlrfp-container", // Recommended: provide the id of the container where the widget should be displayed. 
  id: "widget-identifier",      // Recommended: provide the id property if you plan to have more than one widget on the same page. 
  key: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  uid: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
};
var wlrfp_widget = new wlrfp.widget(options);
```

--------------------------------

### Get RFP Contracts

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/scopes

Retrieves contract information for RFPs.

```APIDOC
## GET /rfp-award/v1/contract/rfps/<rfpId>

### Description
Retrieves contract details related to a specific RFP.

### Method
GET

### Endpoint
`/rfp-award/v1/contract/rfps/<rfpId>`

### Parameters
#### Path Parameters
- **rfpId** (string) - Required - The unique identifier of the RFP.

### Response
#### Success Response (200)
- **contracts** (array) - A list of contract objects.
- **contract** (object) - Represents a single contract.
  - **contractId** (string) - The unique identifier of the contract.
  - **supplierId** (string) - The ID of the supplier associated with the contract.
  - **startDate** (string) - The start date of the contract.
  - **endDate** (string) - The end date of the contract.
  - **status** (string) - The current status of the contract.

#### Response Example
```json
{
  "contracts": [
    {
      "contractId": "cont_xyz",
      "supplierId": "supplier_456",
      "startDate": "2024-07-01",
      "endDate": "2025-06-30",
      "status": "Active"
    }
  ]
}
```
```

--------------------------------

### API Reference Overview

Source: https://developers.cvent.com/docs/rest-api/explanation/using-the-reference

This section provides a general overview of how to use the Cvent Platform REST API reference, explaining its three-pane layout for navigation, specifications, and samples.

```APIDOC
## API Reference Overview

### Description
Provides a guide to the Cvent Platform REST API reference, explaining its structure and how to find information about endpoints, requests, and responses.

### Interface Layout

*   **Navigation Menu**: Browse categories and endpoints, with search functionality.
*   **Specifications Pane**: Displays details for selected API endpoints, including request and response information.
*   **Samples Pane**: Shows example requests and responses for endpoints.
```

--------------------------------

### Get RFP Allocations

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/scopes

Retrieves allocation details for a given RFP.

```APIDOC
## GET /rfp-award/v1/allocation/<rfpId>

### Description
Retrieves the allocation details associated with a specific RFP.

### Method
GET

### Endpoint
`/rfp-award/v1/allocation/<rfpId>`

### Parameters
#### Path Parameters
- **rfpId** (string) - Required - The unique identifier of the RFP.

### Response
#### Success Response (200)
- **allocations** (array) - A list of allocation objects.
- **allocation** (object) - Represents a single allocation.
  - **supplierId** (string) - The ID of the allocated supplier.
  - **awardedAmount** (number) - The amount allocated to the supplier.
  - **awardDate** (string) - The date of the award.

#### Response Example
```json
{
  "allocations": [
    {
      "supplierId": "supplier_456",
      "awardedAmount": 5000.00,
      "awardDate": "2024-06-20"
    }
  ]
}
```
```

--------------------------------

### Get All Attachments for Message

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/scopes

Retrieves all attachments associated with a specific message in an RFP.

```APIDOC
## GET /csn-message/v1/rfp/<rfpId>/messages/<messageId>/attachment/all

### Description
Retrieves all attachments linked to a particular message within an RFP.

### Method
GET

### Endpoint
`/csn-message/v1/rfp/<rfpId>/messages/<messageId>/attachment/all`

### Parameters
#### Path Parameters
- **rfpId** (string) - Required - The unique identifier of the RFP.
- **messageId** (string) - Required - The unique identifier of the message.

### Response
#### Success Response (200)
- **attachments** (array) - A list of attachment objects.
- **attachment** (object) - Represents a single attachment.
  - **attachmentId** (string) - The unique identifier of the attachment.
  - **fileName** (string) - The name of the attachment file.
  - **fileSize** (integer) - The size of the attachment file in bytes.
  - **contentType** (string) - The MIME type of the attachment file.

#### Response Example
```json
{
  "attachments": [
    {
      "attachmentId": "att_abc",
      "fileName": "pricing_sheet.pdf",
      "fileSize": 102400,
      "contentType": "application/pdf"
    }
  ]
}
```
```

--------------------------------

### Supported Arguments for CventInstantBook

Source: https://developers.cvent.com/docs/wl-ibk/deployment

Detailed explanation of the arguments that can be passed to the CventInstantBook constructor for customization.

```APIDOC
## Supported Arguments

### `accessKey`
*   **Type**: String
*   **Required**: Yes
*   **Description**: Identifier for the White Label integration form. Essential for license type identification and venue association. Required even if `buttonTheme.type` is 'none'.

### `venueId`
*   **Type**: String
*   **Required**: Yes
*   **Description**: Identifier for the venue (CSN UUID). Required for the Instant Book button to load correctly. Required even if `buttonTheme.type` is 'none'.

### `containerId`
*   **Type**: String
*   **Required**: Yes (unless `buttonTheme.type` is 'none')
*   **Description**: The HTML `id` attribute of the container where the Instant Book button will be placed. A corresponding `div` element must exist on the webpage.

### `id`
*   **Type**: String
*   **Required**: Optional (Required for Enterprise license with multiple buttons)
*   **Description**: The HTML `id` attribute for the Instant Book button. Uniquely identifies buttons when multiple venues or instances are present on the same page.

### `buttonTheme`
*   **Type**: Object
*   **Required**: Optional
*   **Description**: An object containing styling properties for the Instant Book button.

#### `buttonTheme.type`
*   **Type**: String
*   **Allowed Values**: `'primary'`, `'secondary'`, `'custom'`, `'none'`
*   **Description**:
    *   `'primary'`: Displays a filled button; ignores page font and background properties.
    *   `'secondary'`: Displays an outlined button; ignores page font and background properties.
    *   `'custom'`: Applies custom font and background properties defined within `buttonTheme`.
    *   `'none'`: Hides the Cvent Instant Book button. Allows the venue to implement their own button and call `cventInstantBook.launchInstantBook()` on click. Font and background properties are ignored.

#### `buttonTheme.font`
*   **Type**: Object
*   **Required**: Conditional (for `buttonTheme.type: 'custom'`)
*   **Description**: Defines the font styling for the button.
    *   `fontFamily` (String): The font family to use (e.g., 'Carrois Gothic').
    *   `src` (String): The URL source for the font (e.g., 'url(https://fonts.gstatic.com/s/carroisgothic/v8/Z9XPDmFATg-N1PLtLOOxvIHl9amE1C_4jtJ_.woff2) format(\'woff2')').
    *   `color` (String): The font color (e.g., '#3F4444').

#### `buttonTheme.background`
*   **Type**: Object
*   **Required**: Conditional (for `buttonTheme.type: 'custom'`)
*   **Description**: Defines the background styling for the button.
    *   `color` (String): The background color (e.g., '#97999B').
    *   `border` (String): The border color (e.g., '#3F4444').
```

--------------------------------

### RFP Search Response Example (JSON)

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/searching-rfps

Provides a sample JSON object representing a successful response from the RFP search endpoint.

```json
{
  "totalRecordCount": 55214,
  "fetchedRecordCount": 10,
  "limit": 10,
  "searchAfter": [
    "0006ba18-f124-4c2c-a6fd-cf75ff68fa7c"
  ],
  "rfpIds": [
    "000045f8-7541-4c59-8c6d-c51b2bbf0922",
    "00004e46-1ede-431e-99d2-c522295bbb19",
    "000050c2-87af-475d-a89e-262ef31f6b25",
    "0001856e-e6a4-4c59-ac18-be9db529b762",
    "0003153a-0baf-4ef5-9aad-faa81e9b816b",
    "00035fe1-683b-4b78-96d6-3ea68ec712f7",
    "000553ad-fa1c-4510-8cce-7a76558086f4",
    "00059445-67fe-437e-9cfc-959179749fd6",
    "00059ec5-af40-48d6-a643-4b2357c721db",
    "0006ba18-f124-4c2c-a6fd-cf75ff68fa7c"
  ],
  "rfpSearchEntity": []
}
```

--------------------------------

### Get Venue by ID

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/scopes

Retrieves venue details using its unique venue ID.

```APIDOC
## GET /venue/v1/tpp/venue/<venueId>

### Description
Retrieves detailed information about a venue using its unique identifier.

### Method
GET

### Endpoint
`/venue/v1/tpp/venue/<venueId>`

### Parameters
#### Path Parameters
- **venueId** (string) - Required - The unique identifier of the venue.

### Response
#### Success Response (200)
- **venue** (object) - The venue object.
  - **venueId** (string) - The unique identifier of the venue.
  - **name** (string) - The name of the venue.
  - **address** (string) - The address of the venue.
  - **city** (string) - The city where the venue is located.
  - **country** (string) - The country where the venue is located.

#### Response Example
```json
{
  "venueId": "venue_111",
  "name": "Grand Convention Center",
  "address": "123 Convention Way",
  "city": "Metropolis",
  "country": "USA"
}
```
```

--------------------------------

### Get RFP Contract by Supplier

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/scopes

Retrieves contract information for a specific RFP and supplier.

```APIDOC
## GET /rfp-award/v1/contract/rfps/<rfpId>/suppliers/<supplierId>

### Description
Retrieves contract details for a specific supplier related to a particular RFP.

### Method
GET

### Endpoint
`/rfp-award/v1/contract/rfps/<rfpId>/suppliers/<supplierId>`

### Parameters
#### Path Parameters
- **rfpId** (string) - Required - The unique identifier of the RFP.
- **supplierId** (string) - Required - The unique identifier of the supplier.

### Response
#### Success Response (200)
- **contract** (object) - The contract object for the specified supplier and RFP.
  - **contractId** (string) - The unique identifier of the contract.
  - **supplierId** (string) - The ID of the supplier associated with the contract.
  - **startDate** (string) - The start date of the contract.
  - **endDate** (string) - The end date of the contract.
  - **status** (string) - The current status of the contract.

#### Response Example
```json
{
  "contractId": "cont_xyz",
  "supplierId": "supplier_456",
  "startDate": "2024-07-01",
  "endDate": "2025-06-30",
  "status": "Active"
}
```
```

--------------------------------

### Get Venue by Venue Code

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/scopes

Retrieves venue details using its specific venue code.

```APIDOC
## GET /venue/v1/tpp/venue/venueCode/<venueCode>

### Description
Retrieves detailed information about a venue using its specific venue code.

### Method
GET

### Endpoint
`/venue/v1/tpp/venue/venueCode/<venueCode>`

### Parameters
#### Path Parameters
- **venueCode** (string) - Required - The venue code for identifying the venue.

### Response
#### Success Response (200)
- **venue** (object) - The venue object.
  - **venueId** (string) - The unique identifier of the venue.
  - **name** (string) - The name of the venue.
  - **address** (string) - The address of the venue.
  - **city** (string) - The city where the venue is located.
  - **country** (string) - The country where the venue is located.

#### Response Example
```json
{
  "venueId": "venue_111",
  "name": "Grand Convention Center",
  "address": "123 Convention Way",
  "city": "Metropolis",
  "country": "USA"
}
```
```

--------------------------------

### Samples Pane

Source: https://developers.cvent.com/docs/rest-api/explanation/using-the-reference

Information about the Samples Pane, which displays example request payloads and responses for API endpoints.

```APIDOC
## Samples Pane

### Description
Provides example requests and responses for API endpoints, mirroring the defined schemas.

### Endpoint Address
*   The URL required to access the API endpoint. Supports different data centers (NA, EU).

### Sample Payload (for POST endpoints)
*   A JSON object demonstrating the structure and example data for a request body.

### Response Samples
*   Example responses for different HTTP status codes, illustrating the structure and data returned.
```

--------------------------------

### Get Message Recipients for Supplier

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/scopes

Retrieves the recipients of a message for a specific supplier within an RFP.

```APIDOC
## GET /csn-message/v1/rfp/<rfpId>/messages/<messageId>/recipients/supplier/<supplierId>

### Description
Retrieves the recipients of a specific message, filtered by a supplier, within an RFP.

### Method
GET

### Endpoint
`/csn-message/v1/rfp/<rfpId>/messages/<messageId>/recipients/supplier/<supplierId>`

### Parameters
#### Path Parameters
- **rfpId** (string) - Required - The unique identifier of the RFP.
- **messageId** (string) - Required - The unique identifier of the message.
- **supplierId** (string) - Required - The unique identifier of the supplier.

### Response
#### Success Response (200)
- **recipients** (array) - A list of recipient objects.
- **recipient** (object) - Represents a single recipient.
  - **recipientId** (string) - The unique identifier of the recipient.
  - **name** (string) - The name of the recipient.
  - **role** (string) - The role of the recipient (e.g., 'supplier', 'planner').

#### Response Example
```json
{
  "recipients": [
    {
      "recipientId": "planner_789",
      "name": "John Doe",
      "role": "planner"
    }
  ]
}
```
```

--------------------------------

### Get Supplier Messages for RFP

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/scopes

Retrieves messages sent to a specific supplier for a given RFP.

```APIDOC
## GET /csn-message/v1/rfp/<rfpId>/messages/supplier/<supplierId>

### Description
Retrieves messages exchanged with a specific supplier for a given RFP.

### Method
GET

### Endpoint
`/csn-message/v1/rfp/<rfpId>/messages/supplier/<supplierId>`

### Parameters
#### Path Parameters
- **rfpId** (string) - Required - The unique identifier of the RFP.
- **supplierId** (string) - Required - The unique identifier of the supplier.

### Response
#### Success Response (200)
- **messages** (array) - A list of message objects.
- **message** (object) - Represents a single message.
  - **messageId** (string) - The unique identifier of the message.
  - **content** (string) - The content of the message.
  - **sentTimestamp** (string) - The timestamp when the message was sent.
  - **senderId** (string) - The ID of the message sender.
  - **recipientId** (string) - The ID of the message recipient.

#### Response Example
```json
{
  "messages": [
    {
      "messageId": "msg_123",
      "content": "Hello, please provide your pricing.",
      "sentTimestamp": "2024-06-24T10:00:00Z",
      "senderId": "supplier_456",
      "recipientId": "planner_789"
    }
  ]
}
```
```

--------------------------------

### Users API Response Example (200 OK)

Source: https://developers.cvent.com/docs/legacy-api/jifflenow-api/user/users-list

Example of a successful response (200 OK) from the Users API, containing a list of user objects and pagination details. Includes status, message, data, errors, and request_uuid.

```JSON
{
  "status": 200,
  "message": "Request successful",
  "data": {
    "users": [
      {
        "uuid": "ybm0J2yk4ZIgAkBsX5v4Tw",
        "first_name": "Shawn",
        "last_name": "Clarke",
        "email": "shawnc@example.com",
        "company_role": "CSM",
        "contact_no": "3179665022",
        "created_at": "2024-01-25T14:26:43.640Z",
        "updated_at": "2024-04-25T12:02:43.302Z",
        "status": true,
        "custom_fields": {},
        "timezone": "UTC",
        "consents": [],
        "alias_email": null,
        "personal_link": "https://example-staging.jifflenow.com/my/shawnclarke-xkKj7mT0"
      }
    ],
    "current_page": 1,
    "total_records": 6369,
    "total_pages": 6369,
    "last_sync_at": "2024-09-10T16:00:44Z"
  },
  "errors": {
    "summary": "",
    "details": []
  },
  "request_uuid": "ExternalAPI-cm0wmbxfc00ien2m34lhvrz78-20240910160035"
}
```

--------------------------------

### Get Specific Attachment for Message

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/scopes

Retrieves a specific attachment for a message in an RFP using its attachment ID.

```APIDOC
## GET /csn-message/v1/rfp/<rfpId>/messages/<messageId>/attachment/<attachmentId>

### Description
Retrieves a specific attachment for a message within an RFP, identified by its attachment ID.

### Method
GET

### Endpoint
`/csn-message/v1/rfp/<rfpId>/messages/<messageId>/attachment/<attachmentId>`

### Parameters
#### Path Parameters
- **rfpId** (string) - Required - The unique identifier of the RFP.
- **messageId** (string) - Required - The unique identifier of the message.
- **attachmentId** (string) - Required - The unique identifier of the attachment.

### Response
#### Success Response (200)
- **attachment** (object) - The requested attachment object.
  - **attachmentId** (string) - The unique identifier of the attachment.
  - **fileName** (string) - The name of the attachment file.
  - **fileSize** (integer) - The size of the attachment file in bytes.
  - **contentType** (string) - The MIME type of the attachment file.
  - **content** (string) - The binary content of the attachment (base64 encoded).

#### Response Example
```json
{
  "attachmentId": "att_abc",
  "fileName": "pricing_sheet.pdf",
  "fileSize": 102400,
  "contentType": "application/pdf",
  "content": "JVBERi0xLjQKJ..."
}
```
```

--------------------------------

### HTTP POST: Basic Process for Cvent Registration

Source: https://developers.cvent.com/docs/http-post/guides/process

This section details the steps required to send invitee data to Cvent using an HTTP POST request. It covers obtaining necessary URLs, eCodes, and understanding the required payload fields.

```APIDOC
## HTTP POST /Events/APIs/Reg.aspx

### Description
This endpoint allows you to submit attendee data to Cvent for event registration via an HTTP POST request. It requires specific regional endpoint URLs and event-specific eCodes.

### Method
POST

### Endpoint
`https://www.cvent.com/Events/APIs/Reg.aspx` (North America)
`https://www-eur.cvent.com/Events/APIs/Reg.aspx` (EU)

### Parameters
#### Query Parameters
None

#### Request Body
- **ecode** (string, UUID) - Required - The unique event code (eCode) for the target Cvent event.
- **first_name** (string) - Required - The first name of the invitee. Max length: 30.
- **last_name** (string) - Required - The last name of the invitee. Max length: 50.
- **email_address** (string) - Required - The email address of the invitee. Max length: 50.
- **source_id** (string) - Optional - An identifier for the source of the invitee. Max length: 120. Pass with null if not used.
- **target** (enum) - Optional - Specifies the landing page after submission. Enum values: `Summary`, `Invitation`, `Registration`. 

### Request Example
```json
{
  "ecode": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "first_name": "John",
  "last_name": "Doe",
  "email_address": "john.doe@example.com",
  "source_id": "WEB_FORM_123",
  "target": "Registration"
}
```

### Response
#### Success Response (302 Redirect)
- A 302 HTTP response indicates a successful submission, redirecting the user to the event page.

#### Response Example
(HTTP 302 Redirect to the event registration page)

#### Error Handling
- If required fields are missing or invalid, the user may be redirected to the event summary page, indicating an incomplete process.

### Further Information
- Refer to the Form Fields documentation for details on all available fields.
- Ensure the target Cvent event has registration enabled and active.
```

--------------------------------

### Get Specific Message for RFP

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/scopes

Retrieves a specific message for a given RFP using its message ID.

```APIDOC
## GET /csn-message/v1/rfp/<rfpId>/messages/<messageId>

### Description
Retrieves a specific message within an RFP using its unique identifier.

### Method
GET

### Endpoint
`/csn-message/v1/rfp/<rfpId>/messages/<messageId>`

### Parameters
#### Path Parameters
- **rfpId** (string) - Required - The unique identifier of the RFP.
- **messageId** (string) - Required - The unique identifier of the message.

### Response
#### Success Response (200)
- **message** (object) - The requested message object.
  - **messageId** (string) - The unique identifier of the message.
  - **content** (string) - The content of the message.
  - **sentTimestamp** (string) - The timestamp when the message was sent.
  - **senderId** (string) - The ID of the message sender.
  - **recipientId** (string) - The ID of the message recipient.

#### Response Example
```json
{
  "messageId": "msg_123",
  "content": "Hello, please provide your pricing.",
  "sentTimestamp": "2024-06-24T10:00:00Z",
  "senderId": "supplier_456",
  "recipientId": "planner_789"
}
```
```

--------------------------------

### HTTP POST Request Header Example

Source: https://developers.cvent.com/docs/passkey/REST/callbacks

Provides an example of the header information sent in an HTTP POST request for a callback. This includes essential details like the request method, host, content type, and other metadata.

```http
POST ?r=323F2VKJ HTTP/1.1
User-Agent: Profile/MIDP-1.0 Configuration/CLDC-1.0
Content-Language: en-US
Content-Type: application/x-www-form-URLencoded
Host: uat-manage.passkey.com
Accept: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
Connection: keep-alive
Content-Length: 0
X-Forwarded-For: 82.209.214.162
```

--------------------------------

### Get Obfuscation Status

Source: https://developers.cvent.com/docs/rest-api/guides/obfuscation-guide

Verifies the status of an ongoing obfuscation request using the obfuscation ID.

```APIDOC
## GET /contacts/obfuscate/{obfuscateId}/status

### Description
Verifies the status of an ongoing obfuscation request using the obfuscation ID.

### Method
GET

### Endpoint
`{hostName}/{version}/contacts/obfuscate/{obfuscateId}/status`

### Parameters
#### Path Parameters
- **obfuscateId** (string) - Required - The ID returned from the Obfuscate a Contact endpoint.

#### Headers
- **Accept**: `application/json`
- **Authorization**: `Bearer {accessToken}`

### Request Example
```curl
curl -X GET {hostName}/{version}/contacts/obfuscate/{obfuscateId}/status \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {accessToken}'
```

### Response
#### Success Response (200)
- **status** (string) - The completion status of the obfuscation (e.g., 'Complete', 'Failed').
```

--------------------------------

### Invoicing Flow

Source: https://developers.cvent.com/docs/rest-api/migration-guide/example-workflows

Guides users on how to upload invoices, retrieve event and payment information, and assign invoices to specific payments.

```APIDOC
## POST /api/fileupload

### Description
Uploads files, such as invoices, to the Cvent platform.

### Method
POST

### Endpoint
/api/fileupload

### Parameters
#### Request Body
- **file** (file) - Required - The file to upload.
- **fileName** (string) - Required - The name of the file.

### Request Example
(Form data with file upload)

### Response
#### Success Response (200)
- **invoiceId** (string) - The ID of the uploaded invoice.

#### Response Example
{
  "invoiceId": "invoice_uvw"
}

## GET /api/events

### Description
Retrieves a list of events to obtain an event ID.

### Method
GET

### Endpoint
/api/events

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filters the list of events.

### Response
#### Success Response (200)
- **events** (array) - A list of event objects, each containing an 'id'.

#### Response Example
{
  "events": [
    {
      "id": "event_123",
      "name": "Sample Event"
    }
  ]
}

## GET /api/events/{eventId}/payments

### Description
Retrieves a list of payments made for a specific event.

### Method
GET

### Endpoint
/api/events/{eventId}/payments

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The ID of the event.

### Response
#### Success Response (200)
- **payments** (array) - A list of payment objects, each containing an 'id'.

#### Response Example
{
  "payments": [
    {
      "id": "payment_pqr",
      "amount": 500.00
    }
  ]
}

## POST /api/events/{eventId}/payments/{paymentId}/assigninvoice

### Description
Assigns an uploaded invoice to a specific payment.

### Method
POST

### Endpoint
/api/events/{eventId}/payments/{paymentId}/assigninvoice

### Parameters
#### Path Parameters
- **eventId** (string) - Required - The ID of the event.
- **paymentId** (string) - Required - The ID of the payment.

#### Request Body
- **invoiceId** (string) - Required - The ID of the invoice to assign.

### Request Example
{
  "invoiceId": "invoice_uvw"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Invoice assigned to payment successfully."
}
```

--------------------------------

### Retrieve Venue Object API (GET)

Source: https://developers.cvent.com/docs/legacy-api/csn/supplier-guide/scopes

Fetches details for a specific venue using its unique ID. This operation does not have a specified scope.

```http
GET /venue/v1/venue/<venueId>
```

--------------------------------

### OAuth 2.0 Token Response Example

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/push-notification-system

This is an example of a successful response from an OAuth 2.0 token creation endpoint, as expected by Cvent's PNS. It includes the access token, its expiration time, and the token type.

```JSON
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 3600,
  "token_type": "Bearer"
}
```

--------------------------------

### cURL Request for BadgeKit API

Source: https://developers.cvent.com/docs/legacy-api/badgekit/Setting_Up_Your_Scanning_Software

Example cURL command to call the BadgeKit API for attendee information. Requires the event ID, exhibitor ID, reference ID, and a bearer token for authentication. The bearer token expires after one hour, necessitating re-authentication for subsequent calls.

```shell
curl -X GET \
  https://io.cvent.com/onsite/v1/events/{eventId}/exhibitors/{exhibitorId}/attendees/ {referenceId}-H ‘authorization: Bearer \
  -H ‘content-type: application/json’ < TOKEN_ID > ’
```

--------------------------------

### RFP Account Search Request Body Example (JSON)

Source: https://developers.cvent.com/docs/legacy-api/csn/planner-guide/searching-rfps

Illustrates a JSON request body for the RFP Account Search endpoint, including search criteria and filtering options.

```json
{
  "fields": "rfp_name,rfp_status_name",
  "limit": 50,
  "sortBy": "last_modified_date",
  "filterGroup": {
    "type": "FILTER_GROUP",
    "groupOperator": "AND",
    "filterGroups": [
      {
        "type": "FILTER",
        "fieldName": "rfp_status_id",
        "value": "10"
      },
      {
        "type": "FILTER",
        "fieldName": "event_info.event_start_date.from",
        "value": "2023-01-01"
      },
      {
        "type": "FILTER",
        "fieldName": "event_info.event_start_date.to",
        "value": "2023-12-31"
      }
    ]
  }
}
```