### Example JSON Response for Listing Conferences

Source: https://docs.bigmarker.com/index

This is an example of the JSON structure returned when listing conferences. It includes pagination information and an array of conference objects, each with an ID, title, address, and purpose.

```json
{
  "current_page":1,
  "per_page":25,
  "total_pages":1,
  "total_entries":3,
  "conferences": [
    {
      "id": "xxxxxx1",
      "title": "Conference 1 Title",
      "conference_address": "https://www.bigmarker.com/channel_url/conference_1_url",
      "purpose": "To be great"
    },
    {
      "id": "xxxxxx2",
      "title": "Conference 2 Title",
      "conference_address": "https://www.bigmarker.com/channel_url/conference_2_url",
      "purpose": "To be great"
    }
  ]
}
```

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

### Subchannel Creation Response Structure

Source: https://docs.bigmarker.com/index

Example JSON structure for the response when creating a subchannel. It includes the new channel's ID, URL, name, and overview.

```json
{
  "channel_id": "xxxxxx1",    
  "channel_url": "https://www.bigmarker.com/subchannel1_url",
  "name": "Subchannel 1 Name",
  "overview": "Subchannel 1 Overview"
}
```

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

### GET /api/v1/channels/

Source: https://context7.com/context7/bigmarker/llms.txt

Retrieves a list of all channels accessible with the provided API key.

```APIDOC
## List Channels

### Description
Get all channels accessible with your API key.

### Method
GET

### Endpoint
`/api/v1/channels/`

### Parameters
None

### Request Example
```bash
curl -i -H "API-KEY:xxxxxx"  https://www.bigmarker.com/api/v1/channels/
```

### Response
#### Success Response (200)
- **channel_id** (string) - The unique identifier of the channel.
- **name** (string) - The name of the channel.
- **channel_url** (string) - The URL of the channel.

#### Response Example
```json
[
  {
    "channel_id": "channel_abc123",
    "name": "Acme Corp Training",
    "channel_url": "https://www.bigmarker.com/mycompany"
  },
  {
    "channel_id": "channel_def456",
    "name": "Marketing Webinars",
    "channel_url": "https://www.bigmarker.com/acme-marketing"
  }
]
```
```

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

### Channel Registrant Response Structure

Source: https://docs.bigmarker.com/index

Example JSON structure for the response when listing channel registrants. It includes an array of registration objects, each with email, first name, and last name.

```json
{
    "registrations": [{
        "email": "example.user1@bigmarker.com",
        "first_name": "Example",
        "last_name": "user"
    },
    {
        "email": "another.registrant2@bigmarker.com",
        "first_name": "Another",
        "last_name": "Registrant"
    }]
  }
```

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

### POST /websites/bigmarker

Source: https://docs.bigmarker.com/index

This endpoint allows you to create a new conference or webinar on BigMarker. You can specify various details such as title, schedule type, start time, and customization options.

```APIDOC
## POST /websites/bigmarker

### Description
Creates a new conference or webinar.

### Method
POST

### Endpoint
/websites/bigmarker

### Parameters
#### Request Body
- **channel_id** (String) - Required - The channel ID that you want to create this conference for.
- **title** (String) - Required - The title of your conference, maximum length 100 characters.
- **conference_copy_id** (String) - Optional - The ID from the conference/template to be copied
- **presenter_exit_url** (String) - Optional - The site presenters are redirected to after the conference is over.
- **sub_url** (String) - Optional - Sub URL of the conference. If the whole URL is www.bigmarker.com/channel/example-conference, the sub URL is “example-conference”.
- **enable_dial_in** (Boolean) - Optional - True if conference dial-in should be enabled, defaults to false if conference dial-in should be disabled.
- **purpose** (String) - Optional - A description of your conference
- **time_zone** (String) - Optional - The time zone of your start time. Please visit the Time Zones section for a list of acceptable values. Defaults to ‘Central Time (US & Canada)’
- **room_logo** (String) - Optional - A URL to the image to the room logo
- **conference_logo** (String) - Optional - A URL to the image to the landing page logo
- **apply_conference_logo_to_channel** (Boolean) - Optional - whether the conference logo is being used as the channel logo
- **room_sub_title** (String) - Optional - Sub title for room.
- **schedule_type** (String) - Optional - Use either “24_hour_room” for a meeting space or “one_time” for a webinar. Use “multiple_times”. only when it’s a recurring webinar. Apply it together with "recurring_start_time”.
- **start_time** (String) - Optional - The start time of your conference (required if a one time webinar is being created). For example: “2020-01-01 15:00”.
- **recurring_start_times** (Array) - Optional - Array of recurring start times. JSON format: ["20xx-xx-xx 15:00:00+02:00","20xx-xx-xx 16:00:00+02:00"],Make sure to apply “schedule_type":“multiple_times” together with it to make sure the api call applies without error.
- **webcast_mode** (String) - Optional - Acceptable values: 'automatic’, 'required’, 'optional’. Default value: 'automatic’
- **duration_minutes** (String) - Optional - Duration of the event in minutes. Range 1 to 720 minutes. Default is 60 minutes.
- **who_can_watch_recording** (String) - Optional - Set the view permission of the recordings. Acceptable values: 'everyone’, 'channel_admin_only’, 'channel_subscribers’,'attendees’,'attendees_registrants’. Default value: 'everyone’
- **presenter_advanced_enter_time** (String) - Optional - Accepts values: '60’, '120’ and '180’. Default is set to '60’.
- **attendee_advanced_enter_time** (String) - Optional - Accepts values: '15’, '30’. Default is set to '15’.
- **privacy** (String) - Optional - Defaults to 'public’ if the event is to be listed publicly, 'private’ if the event should be kept private.
- **webinar_format** (String) - Optional - Acceptable values: 'webinar’, 'livestream’, 'on_demand’, 'automated’. Default is 'webinar’
- **ondemand_video_url** (String) - Optional - Provide a MP4 video url.
- **enable_knock_to_enter** (Boolean) - Optional - Defaults to false so attendees do not have to knock to join the room. Set this to true to enable knocking to enter.
- **registration_conf_emails** (Boolean) - Optional - Defaults to true to send registration confirmation and reminder emails, false if these emails should not be sent. **Warning:** These emails contain vital information for members, including personalized event links and webinar information.
- **send_notification_emails_to_presenters** (Boolean) - Optional - Whether reminder emails should be sent to presenters. Defaults to true.
- **send_reminder_emails_to_presenters** (Boolean) - Optional - Defaults to true to send reminder emails to admin and presenters of this conference.
- **show_reviews** (Boolean) - Optional - Defaults to true if reviews should be displayed, false if reviews should be hidden.
- **review_emails** (Boolean) - Optional - Defaults to true if review emails should be sent to attendees, false if review emails should be disabled.
- **poll_results** (Boolean) - Optional - Defaults to true so attendees can see poll results, false if poll results should be hidden.
- **enable_ie_safari** (Boolean) - Optional - Set to true so attendees can enter the event using Safari or Internet Explorer 11 (in beta). Defaults to false to disable this feature.
- **enable_twitter** (Boolean) - Optional - Enables Twitter integration that displays all the Tweets from a specific Hashtag. Defaults to true.
- **send_cancellation_email** (Boolean) - Optional - Defaults to true to notify all registrants that a conference was cancelled. Set this to false to prevent these notifications.
- **webhook_url** (String) - Optional - URL to send new conference registration info to.
- **exit_url** (String) - Optional - The site attendees are redirected to after the conference is over.
- **enable_create_webinar_reg_webhook** (Boolean) - Optional - Whether the Webinar can accept new registrations via Webhook. Defaults to “False"

### Request Example
```json
{
  "channel_id": "your_channel_id",
  "title": "My Awesome Webinar",
  "start_time": "2024-12-31 14:00",
  "schedule_type": "one_time",
  "webinar_format": "webinar"
}
```

### Response
#### Success Response (200)
- **conference_id** (String) - The unique identifier for the created conference.
- **conference_url** (String) - The URL to access the created conference.

#### Response Example
```json
{
  "conference_id": "conf_abc123",
  "conference_url": "https://bigmarker.com/your_channel/my-awesome-webinar"
}
```
```

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

### GET /api/v1/conferences/survey/:conference_id

Source: https://docs.bigmarker.com/index

Retrieves survey data for a specific conference. This API call allows you to get handout download data.

```APIDOC
## Show survey data

You can use this API call get handout download data

### Method
GET

### Endpoint
`https://www.bigmarker.com/api/v1/conferences/survey/:conference_id`

### Parameters
#### Path Parameters
- **conference_id** (String) - Required - ID of conference.

#### Query Parameters
- **created_since** (String) - Optional - Any survey data created before the ‘created_since’ timestamp will not be included in the response. For example: 1687759589.

#### Request Headers
- **API-KEY** (String) - Required - Your Bigmarker API key.

### Response
#### Success Response (200)
- **question_title** (String) - Survey's title.
- **answer_type** (String) - Type of answer.
- **review_response** (String) - Survey response.

#### Response Example
```json
{
  "question_title": "xxxxxxxx",
  "answer_type": "start_rating",
  "choice_type": "single",
  "responses": [
    {
      "review_response": "xxxxxx",
      "review": {
        "created_at": "xxxx",
        "email": "xxx",
        "name": "xxx"
      }
    }
  ]
}
```

### Error Response
- **401 Unauthorized**: Missing or invalid API key.
- **401 conference_permission_denied**: You do not have permission to access or modify this conference.
- **404 conference_not_found**: The conference you are requesting is not found.
```

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

### GET /api/v1/registration_block_list/:conference_id - Get Emails from List

Source: https://docs.bigmarker.com/index

Retrieves emails from a specified list (block or allow) for a given conference. Supports pagination.

```APIDOC
## GET /api/v1/registration_block_list/:conference_id

### Description
Retrieves emails from a specified block or allow list for a conference.

### Method
GET

### Endpoint
`https://www.bigmarker.com/api/v1/registration_block_list/:conference_id`

### Parameters
#### Path Parameters
- **conference_id** (String) - Required - Conference ID

#### Query Parameters
- **list_type** (String) - Required - Specifies the list to retrieve emails from. Accepts 'block_list', 'allow_list', 'block_except_list', 'allow_except_list'.

### Request Example
```bash
curl -i -X GET -H "API-KEY:xxxxxx" https://www.bigmarker.com/api/v1/registration_block_list/:conference_id?list_type=allow_list
```

### Response
#### Success Response (200)
- **per_page** (Integer) - Number of entries per page.
- **current_page** (Integer) - The current page number.
- **total_entries** (Integer) - Total number of entries across all pages.
- **total_pages** (Integer) - Total number of pages.
- **list** (Array) - Contains details of emails in the list.
  - **email** (String) - The email address.
  - **created_at** (String) - Timestamp when the email was added.

#### Response Example
```json
{
  "per_page": 500,
  "current_page": 1,
  "total_entries": 6,
  "total_pages": 1,
  "list": [
    {
      "email": "test@test.com",
      "created_at": "2022-12-20T14:30:11+08:00"
    }
  ]
}
```

### Error Response
- **401** (channel_permission_denied) - You do not have permission to access this channel.
- **404** (channel_not_found) - The channel you are requesting is not found.
```

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

### Show Channel Details

Source: https://context7.com/context7/bigmarker/llms.txt

Fetches detailed information about a specific channel, including its settings, branding, and subscriber count. Requires the channel ID and a valid API key.

```bash
curl -i -H "API-KEY:xxxxxx" \
  https://www.bigmarker.com/api/v1/channels/channel_abc123
```

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

### GET /api/v1/conferences/dial_in_list/:conference_id

Source: https://docs.bigmarker.com/index

Retrieves dial-in data for a specific conference. This API call allows you to get dial-in information associated with a conference.

```APIDOC
## Show dial in data

You can use this API call get dial-in data

### Method
GET

### Endpoint
`https://www.bigmarker.com/api/v1/conferences/dial_in_list/:conference_id`

### Parameters
#### Path Parameters
- **conference_id** (String) - Required - ID of conference.

#### Request Headers
- **API-KEY** (String) - Required - Your Bigmarker API key.

### Response
#### Success Response (200)
- **number_called** (String) - Dial-in number.
- **first_name** (String) - Registrant's first name.
- **last_name** (String) - Registrant's last name.
- **email** (String) - Registrant's email.
- **bmid** (String) - Bigmarker ID.
- **called_start_time** (String) - Time the call started.
- **called_duration** (String) - Duration of the call.
- **role** (String) - Role of the registrant.

#### Response Example
```json
{
  "number_called": "1 (312) 242-2222",
  "first_name": "xxx",
  "last_name": "xxx",
  "email" : "xxx",
  "bmid" : "xxx",
  "called_start_time" : "xxx",
  "called_duration" : "xxx",
  "role" : "Member"
}
```

### Error Response
- **401 Unauthorized**: Missing or invalid API key.
- **401 conference_permission_denied**: You do not have permission to access or modify this conference.
- **404 conference_not_found**: The conference you are requesting is not found.
```

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

### Webinar Settings Parameters

Source: https://docs.bigmarker.com/index

Parameters related to webinar settings, such as breakout rooms, recording options, and time zones.

```APIDOC
## Webinar Settings

### Description
These parameters control various settings for a Bigmarker webinar, including breakout room configurations, recording availability, and general webinar properties.

### Parameters
- **allow_breakout_slide** (Boolean) - Enables attendees to upload slides in interactive breakout rooms. Defaults to `false`.
- **main_room_return** (Boolean) - Enables attendees to return to the main webinar room from breakout rooms at any time. Defaults to `false`.
- **unnassigned_attendee** (String) - Determines how unassigned attendees enter breakout rooms. Accepted values: `'Random'`, `'Manual'`, `'Stay'`. Defaults to `'Manual'`.
- **unnassigned_presenter** (String) - Determines how unassigned presenters enter breakout rooms. Accepted values: `'Random'`, `'Manual'`, `'Stay'`. Defaults to `'Stay'`.
- **breakout_room_total** (String) - Determines the number of breakout rooms. Acceptable values are from 1 to 50.
- **time_zone** (String) - Specifies the conference time zone.
- **tags** (Array) - An array containing webinar tags, each with a name and value.
- **auto_publish_time** (String) - The scheduled time for automatic recording publication.
- **auto_unpublish_time** (String) - The scheduled time for automatic recording unpublication.
- **last_publish_time** (String) - The timestamp of the last recording publication.
- **last_unpublish_time** (String) - The timestamp of the last recording unpublication.
- **is_recording_published** (Boolean) - Indicates if the recording is currently published.

### Recording Availability
If the conference has ended and a recording is available, the following parameters will also be returned:
- **recording_url** (String) - The URL of the recording file.
- **recording_iframe** (String) - The embed code for the recording.
```

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

### Create a MeetingSpace

Source: https://docs.bigmarker.com/index

Creates a new meeting space for a given channel.

```APIDOC
## Create a MeetingSpace

### Description
To create a new meeting_space.

### Method
POST

### Endpoint
https://www.bigmarker.com/api/v1/meeting_spaces

### Parameters
#### Request Body
- **channel_id** (String) - Required - ID of the channel that the MeetingSpace will be created for.
- **title** (String) - Required - Title of the MeetingSpace, up to 70 characters.
- **url** (String) - Required - Subdomain for your MeetingSpace URL. Your final MeetingSpace URL will have the format of: [your-subdomain].meetingspace.io.
- **knock_to_enter** (String) - Optional - Sets whether users need to knock before entering MeetingSpace. Acceptable values: ‘Open’, 'Closed’. Defaults to: “Open”.
- **auto_share_camera** (Boolean) - Optional - Sets whether MeetingSpace guests are prompted for microphone and camera on entry. Defaults to: true.
- **display_dial_in** (Boolean) - Optional - Sets whether dial-in information is listed inside of MeetingSpace. Defaults to false.
- **meeting_style** (String) - Optional - Sets the style of the MeetingSpace. Acceptable values: 'Classic’, 'New_experience’. Defaults to: “New_experience”.
- **logo** (String) - Optional - A URL to an image for the MeetingSpace logo.
- **logo_url** (String) - Optional - A URL that users will be directed to when they click on the MeetingSpace logo.
- **background_image** (String) - Optional - A URL to an image for the MeetingSpace background.
- **preview_image** (String) - Optional - A URL to an image shown when sharing the MeetingSpace URL.
- **email** (String) - Optional - Email address of the meetingspace owner.
- **first_name** (String) - Optional - First Name of the MeetingSpace Owner.
- **last_name** (String) - Optional - Last name of the MeetingSpace Owner.

### Request Example
```json
{
  "channel_id": "your_channel_id",
  "title": "This is your meeting space title"
}
```

### Response
#### Success Response (200)
- **id** (String) - Meeting Space id
- **title** (String) - Title of the MeetingSpace
- **url** (String) - Subdomain for your MeetingSpace URL.
- **knock_to_enter** (String) - Users need to knock before entering MeetingSpace.
- **auto_share_camera** (Boolean) - MeetingSpace guests are prompted for microphone and camera on entry.
- **display_dial_in** (Boolean) - dial-in information.
- **meeting_style** (String) - Style of the MeetingSpace.
- **logo** (String) - A URL to an image for the MeetingSpace logo.
- **logo_url** (String) - A URL that users will be directed to when they click on the MeetingSpace logo.
- **background_image** (String) - A URL to an image for the MeetingSpace background.
- **preview_image** (String) - A URL to an image shown when sharing the MeetingSpace URL.

#### Response Example
```json
{
  "id": "xxxxxx",
  "title": "Title",
  "url": "https://meeting069999.bigmarker.net",
  "knock_to_enter": "Open",
  "auto_share_camera": true,
  "display_dial_in": false,
  "logo": "log",
  "logo_url": "logo_url",
  "meeting_style": "New_experience",
  "background_image": "background_image",
  "preview_image": "preview_image"
}
```

### Error Response
- **Status**: 401, **Type**: channel_permission_denied, **Message**: You do not have permission to access this channel.
- **Status**: 404, **Type**: channel_not_found, **Message**: The channel you are requesting is not found.
```

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

### Get Associated Sessions using cURL

Source: https://docs.bigmarker.com/index

This cURL command illustrates how to retrieve all child conferences (associated sessions) for a given webinar using its conference ID. It requires an API key and performs a GET request to the specified endpoint. The response is a JSON object containing pagination details and an array of conference objects.

```bash
curl -i -H "API-KEY:xxxxxx" https://www.bigmarker.com/api/v1/conferences/get_associated_sessions/:conference_id
```

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

### GET /api/v1/channels/:channel_url/conferences

Source: https://docs.bigmarker.com/index

Retrieves a list of conferences from a specified channel.

```APIDOC
## GET /api/v1/channels/:channel_url/conferences

### Description
This API call retrieves all conferences belonging to a specific channel.

### Method
GET

### Endpoint
`https://www.bigmarker.com/api/v1/channels/:channel_url/conferences`

### Parameters
#### Path Parameters
- **channel_url** (String) - Required - Your channel URL.

#### Query Parameters
- **timing** (String) - Optional - The time frame the list of conferences should be in. Values: `future` (default), `all`, `past`.
- **page** (Integer) - Optional - The page number of the list. Defaults to 1.
- **show_template** (Boolean) - Optional - Show webinar templates. Defaults to `false`.
- **per_page** (Integer) - Optional - How many conferences per page to fetch. Defaults to 25.
- **bmid** (String) - Optional - Only return conferences containing a registrant with the BMID.
- **sort_start_date** (String) - Optional - Sort results by start date. Format: `yyyy-mm-ddTHH:MM:SSZ`. Values: `ascending`, `descending`.
- **webinar_tags** (Array) - Optional - Only return conferences with these tag values. Example: `[{tag_name_1: tag value 1}, {tag_name_2: tag value 2}]`.
- **included_sub_channel_ids** (String) - Optional - Comma-separated sub-channel IDs to include in the results along with the main channel's webinars. Example: `sub1,sub2,sub3`.

### Request Example
```bash
curl -i -H "API-KEY:xxxxxx" 'https://www.bigmarker.com/api/v1/channels/:channel_url/conferences'
```

### Response
#### Success Response (200)
- **conferences** (Array) - List of conferences in the channel. Each conference object contains parameters detailed in the 'Show Conference' endpoint (not provided here).

#### Response Example
```json
{
  "conferences": [
    {
      "id": "xxxxxx1",
      "title": "Conference 1 Title",
      "conference_address": "https://www.bigmarker.com/channel_url/conference_1_url",
      "purpose": "To be great"
    },
    {
      "id": "xxxxxx2",
      "title": "Conference 2 Title",
      "conference_address": "https://www.bigmarker.com/channel_url/conference_2_url",
      "purpose": "To be great"
    }
  ]
}
```

#### Error Response
- **401** - Unauthorized - `{"error":"Missing or invalid API key."}`
- **403** - `{"error":"You don’t have access to this Channel"}`
- **404** - URL Error - `{"error":"Channel Not Found!"}`
```

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

### Publish Recording

Source: https://context7.com/context7/bigmarker/llms.txt

Make a conference recording publicly accessible. Requires an API key for authentication.

```bash
# Publish recording (make publicly accessible)
curl -i -H "API-KEY:xxxxxx" \
  https://www.bigmarker.com/api/v1/conferences/conf_abc123/publish_recording
```

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

### GET /api/v1/channels/

Source: https://docs.bigmarker.com/index

Retrieves a list of all channels associated with the authenticated user.

```APIDOC
## GET /api/v1/channels/

### Description
This API call retrieves all of your channels.

### Method
GET

### Endpoint
`https://www.bigmarker.com/api/v1/channels/`

### Parameters
#### Headers
- **API-KEY** (String) - Required - Put api_token in the header

### Request Example
```bash
curl -i -H "API-KEY:xxxxxx"  https://www.bigmarker.com/api/v1/channels/
```

### Response
#### Success Response (200)
- **channels** (Array) - List of all channels.
  Each channel object contains:
  - **channel_id** (String) - Channel ID
  - **channel_url** (String) - Channel URL
  - **name** (String) - Channel name
  - **overview** (String) - Channel overview
  - **description** (String) - Channel description
  - **channel_hosts** (Array) - all the hosts and admins on the channel

#### Response Example
```json
{
  "channels":
  [
    {
      "channel_id": "xxxxxx1",
      "channel_url": "https://www.bigmarker.com/channel1_url",
      "name": "Channel 1 Name",
      "overview": "Channel 1 Overview"
    },
    {
      "channel_id": "xxxxxx2",
      "channel_url": "https://www.bigmarker.com/channel2_url",
      "name": "Channel 2 Name",
      "overview": "Channel 2 Overview"
    }
  ]
}
```

#### Error Response
- **401** - Unauthorized - `{"error":"Missing or invalid API key."}`
- **404** - URL Error - `{"error":"Not Found!"}`
```

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

### Create a BigMarker Conference (Bash)

Source: https://context7.com/context7/bigmarker/llms.txt

Create a new webinar, livestream, on-demand event, or automated webinar with various configuration options. The request body is sent as JSON.

```bash
curl https://www.bigmarker.com/api/v1/conferences \
  -i -X POST -H "API-KEY:xxxxxx" \
  -H "Content-Type:application/json" \
  -d '{ 
    "channel_id": "my_channel_id",
    "title": "Lead Generation Masterclass",
    "purpose": "Learn proven strategies for B2B lead generation",
    "start_time": "2025-10-15 14:00",
    "time_zone": "Eastern Time (US & Canada)",
    "duration_minutes": "60",
    "privacy": "public",
    "webinar_format": "webinar",
    "schedule_type": "one_time",
    "webcast_mode": "automatic",
    "room_type": "presentation",
    "enable_registration": true,
    "enable_knock_to_enter": false,
    "auto_record": true,
    "send_reminder_emails": true
  }'

# Response includes conference_id, conference_url, admin_url
# Use conference_id for subsequent operations
```

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

### GET /api/v1/conferences/:conference_id/handouts

Source: https://docs.bigmarker.com/index

Retrieves a list of handouts for a specific conference.

```APIDOC
## Get Conference Handouts

### Description
Retrieves a list of handouts associated with a specific conference.

### Method
GET

### Endpoint
`/api/v1/conferences/:conference_id/handouts`

### Parameters
#### Path Parameters
- **conference_id** (String) - Required - The ID of the conference.

#### Headers
- **API-KEY** (String) - Required - Your BigMarker API key.

### Response
#### Success Response (200)
- **Handouts** (Array) - A list of handouts for the webinar.

#### Response Example
```json
{
  "Handouts": [
    "handout1.pdf",
    "handout2.docx"
  ]
}
```

### Error Response
- **Unauthorized** (401) - `{"error":"Missing or invalid API key."}`
- **URL Error** (404) - `{"error":"Not Found!"}`
```

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

### Example JSON Response for Live Attendees

Source: https://docs.bigmarker.com/index

This JSON structure represents the expected output when successfully fetching live conference attendees. It contains an 'attendees' array, with each object detailing an attendee's information, including personal details, engagement metrics, and device information.

```json
{
  "attendees": [
      {
          "id":"931xx2d8cxxx",
          "first_name":"first_name",
          "last_name":"first_name",
          "email": "example.user1@bigmarker.com",
          "BMID":"xxfb4939xxx",
          "coupon":"",
          "registration_date":"2022-03-21T11:25:30",
          "country":"United States",
          "time_zone":"America/Chicago",
          "active_consent":"Yes",
          "traffic_source":"Registration Modal",
          "referral_domain":"https://www.google.com",
          "tracking_code":"email_footer",
          "attended?":"Yes",
          "watched_on_demand":"No",
          "on_demand_duration":"0.5 min",
          "duration":"62.9 min",
          "engaged":"0.7 min",
          "chats":10,
          "qa":10,
          "polls":10,
          "polls_info":[
              {
                  "question": "xxx",
                  "answer": "xxx"
               }
           ],
          "rating":5,
          "comment":"xxxx",
          "banned":"No",
          "custom_fields":{
            "custom_field_1": "response_1",
            "custom_field_2": "response_2"
           },
          "recording_duration":"1.2 min",
          "enter_time": "2022-03-17T13:39:15",
          "exit_time": "2022-03-17T13:42:15",
          "OS": "desktop",
          "browser": "Microsoft Edge",
          "downloaded": 3,
          "handout_name": [
              "handout.jpg"
          ]
        }
    ]
}
```

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

### Publish Webinar Recording using cURL

Source: https://docs.bigmarker.com/index

This snippet shows how to publish a webinar recording using cURL. It requires the conference ID and an API key. The response indicates the status of the publishing action.

```bash
curl -i -H "API-KEY:xxxxxx" 'https://www.bigmarker.com/api/v1/conferences/:conference_id/publish_recording'
```

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

### Get Conference Custom Fields API

Source: https://context7.com/context7/bigmarker/llms.txt

Retrieves custom registration fields configured for a specific conference. This GET request requires an API key and the conference ID. The response is a JSON array containing details of each custom field, including its ID, name, type, and options if applicable.

```bash
curl -i -H "API-KEY:xxxxxx" \
  https://www.bigmarker.com/api/v1/conferences/conf_abc123/custom_fields
```

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

### Manage Channels

Source: https://docs.bigmarker.com/index

Endpoints for managing channels, including creating, listing, and managing associated content.

```APIDOC
## List Channels

### Description
Retrieves a list of channels.

### Method
GET

### Endpoint
/api/v1/channels

### Response
#### Success Response (200)
- **channels** (array) - An array of channel objects.

#### Response Example
```json
{
  "channels": [
    {
      "id": "channel_abc",
      "name": "Example Channel"
    }
  ]
}
```

---

## Create a Subchannel

### Description
Creates a subchannel within a parent channel.

### Method
POST

### Endpoint
/api/v1/channels/{parent_channel_id}/subchannels

### Parameters
#### Path Parameters
- **parent_channel_id** (string) - Required - The ID of the parent channel.

#### Request Body
- **name** (string) - Required - The name of the subchannel.

### Request Example
```json
{
  "name": "Subchannel Name"
}
```

### Response
#### Success Response (201)
- **subchannel_id** (string) - The ID of the newly created subchannel.

#### Response Example
```json
{
  "subchannel_id": "sub_xyz"
}
```

---

## Remove Subchannel

### Description
Removes a subchannel.

### Method
DELETE

### Endpoint
/api/v1/channels/{channel_id}/subchannels/{subchannel_id}

### Parameters
#### Path Parameters
- **channel_id** (string) - Required - The ID of the parent channel.
- **subchannel_id** (string) - Required - The ID of the subchannel to remove.

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

#### Response Example
```json
{
  "message": "Subchannel removed successfully."
}
```
```

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

### GET /api/v1/conferences/:conference_id/recording_views

Source: https://docs.bigmarker.com/index

Retrieves a list of recording views for a specific conference.

```APIDOC
## Show Conference Recording Views

### Description
To get a list of conference recording views.

### Method
GET

### Endpoint
`https://www.bigmarker.com/api/v1/conferences/:conference_id/recording_views`

### Parameters
#### Path Parameters
- **conference_id** (string) - Required - The ID of the conference to retrieve recording views for.

### Request Example
```bash
curl https://www.bigmarker.com/api/v1/conferences/:conference_id/recording_views -i -H "API-KEY:xxxxxx"
```

### Response
#### Success Response (200)
- **recording_views** (array) - List of recording views.
  Each recording_view will have the following parameters:
  - **id** (string) - Recording View Id
  - **bmid** (string) - Unique registrant ID
  - **conference_id** (string) - Conference Id
  - **created_at** (string) - Time at which the recording view is created
  - **watch_duration** (integer) - Watch duration in minutes

#### Response Example
```json
{
    "recording_views": [
        {
            "id": "xxxxxx",
            "bmid":"xxxxxx",
            "conference_id":"xxxxxx",
            "created_at":"2019-08-07T16:26:12Z",
            "watch_duration":23
        },
        {
            "id": "xxyyyx",
            "bmid":"xyxyx",
            "conference_id":"yyyxxx",
            "created_at":"2020-08-07T16:26:12Z",
            "watch_duration":12
        }
    ]
}
```

### Error Handling
- **Unauthorized** (401) - `{"error":"Missing or invalid API key."}`
- **Channel Permission Denied** (403) - `{"error":"You don’t have access to this channel"}`
- **Not Found** (404) - `{"error":"This webianr does not have any recordings."}`
```

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

### GET /api/v1/conferences/{conference_id}/stats

Source: https://docs.bigmarker.com/index

Generates a downloadable URL for the webinar statistics report.

```APIDOC
## Download Statistics Report

### Description
Provides a URL to download the statistics report for a webinar. This URL will log in to the admin's account to facilitate the download.

### Method
GET

### Endpoint
`/api/v1/conferences/{conference_id}/stats`

### Parameters
#### Path Parameters
- **conference_id** (String) - Required - Your conference ID.

#### Query Parameters
- **bmid** (String) - Required - The BMID of the admin for whom the report should be generated.

#### Headers
- **API-KEY** (String) - Required - Your BigMarker API key.

### Request Example
```bash
curl 'https://www.bigmarker.com/api/v1/conferences/{conference_id}/stats?bmid=xxx' -i -H "API-KEY:xxxxxx"
```

### Response
#### Success Response (200)
- **report_url** (String) - A URL to download the webinar statistics report.

#### Response Example
```json
{
  "report_url": "https://www.bigmarker.com/conferences/report_url"
}
```
```

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

### Upload Pre-Loaded File - Bigmarker API

Source: https://context7.com/context7/bigmarker/llms.txt

Adds presentation files or videos to be used during a conference. Requires the conference ID, a URL to the file, and an option to enable autoplay. Supported formats include PDF, PPTX, and various video types. Processed files become available in the presenter controls.

```bash
curl https://www.bigmarker.com/api/v1/conferences/conf_abc123/upload_file \
  -i -X PUT -H "API-KEY:xxxxxx" \
  -H "Content-Type:application/json" \
  -d '{
    "file_url": "https://mysite.com/presentations/sales-deck.pptx",
    "autoplay": "false"
  }'
```

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

### GET /api/v1/custom_emails/:custom_email_id/suppressions

Source: https://docs.bigmarker.com/index

Retrieves a list of suppressed email addresses for a given custom email.

```APIDOC
## GET /api/v1/custom_emails/:custom_email_id/suppressions

### Description
Retrieves a list of suppressed email addresses for a given custom email. This is useful for identifying recipients who have opted out or bounced.

### Method
GET

### Endpoint
`https://www.bigmarker.com/api/v1/custom_emails/:custom_email_id/suppressions`

### Parameters
#### Path Parameters
- **custom_email_id** (String) - Required - Custom Email ID.

#### Query Parameters
- **API-KEY** (String) - Required - Put api_token in the header.

### Request Example
```json
{
  "API-KEY": "xxxxxx"
}
```

### Response
#### Success Response (200)
- **recipient** (String) - recipient’s email
- **action_type** (String) - The type of activities you want to include in the report. Accepted values are “all” “delivered” “opened” “clicked” and “suppressed”.
- **action_time** (String) - action_time

#### Response Example
```json
{
  "recipient": "suppressed@email.com",
  "action_type": "suppressed",
  "action_time": "2022-10-24T16:24:03+08:00"
}
```

### Error Response
- **Unauthorized** (401) - {"error":"Missing or invalid API key."}
- **Channel Permission Denied** (401) - {"error":"You do not have permission to access or modify this conference"}
- **Conference not Found** (404) - {"error":"The conference you are requesting is not found."}
```

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

### List All Channels

Source: https://context7.com/context7/bigmarker/llms.txt

Retrieves a list of all channels that can be accessed with the provided API key. This endpoint is useful for discovering available channels and their basic information. Requires a valid API key.

```bash
curl -i -H "API-KEY:xxxxxx" \
  https://www.bigmarker.com/api/v1/channels/
```

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

### Upload Handout - Bigmarker API

Source: https://context7.com/context7/bigmarker/llms.txt

Adds downloadable resources for attendees to a conference. Requires the conference ID, a URL for the handout, and a title and description for the resource. Handouts appear in the conference sidebar, and download tracking is available in reports.

```bash
curl https://www.bigmarker.com/api/v1/conferences/conf_abc123/add_handout_with_url \
  -i -X POST -H "API-KEY:xxxxxx" \
  -H "Content-Type:application/json" \
  -d '{
    "handout_url": "https://mysite.com/resources/roi-calculator.xlsx",
    "title": "ROI Calculator Template",
    "description": "Excel template for calculating marketing ROI"
  }'
```

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

### GET /api/v1/conferences/registrations/channel/:channel_id

Source: https://docs.bigmarker.com/index

Retrieves a list of all registrants for a specific channel. Supports pagination and filtering.

```APIDOC
## List Channel Registrants

### Description
To get all registrants for a channel.

### Method
GET

### Endpoint
`https://www.bigmarker.com/api/v1/conferences/registrations/channel/:channel_id`

### Parameters
#### Path Parameters
- **channel_id** (String) - Required - The URL slug of your channel.

#### Query Parameters
- **page** (Integer) - Optional - The page number of the list. Defaults to 1.
- **per_page** (Integer) - Optional - How many registrations per page to fetch. Defaults to 25.
- **use_api_name** (Boolean) - Optional - True if you want to get API name rather than custom field title in the response.
- **bmid** (String) - Optional - The unique ID of the registrant.
- **email** (String) - Optional - The email address of the registrant.
- **start_time** (Integer) - Optional - The beginning time of your time filter (Unix timestamp).
- **end_time** (Integer) - Optional - The ending time of your time filter (Unix timestamp).

### Request Example
```bash
curl -i -H "API-KEY:xxxxxxx" https://www.bigmarker.com/api/v1/conferences/registrations/channel/:channel_id
```

### Response
#### Success Response (200)
- **registrations** (Array) - List of registrant objects.
  - **email** (String) - Registrant email.
  - **first_name** (String) - Registrant’s first name.
  - **last_name** (String) - Registrant’s last name.
  - **id** (String) - Registration Id.
  - **conference_id** (String) - Conference Id.
  - **enter_url** (String) - Personalized url to enter a conference.
  - **bmid** (String) - Unique registrant ID.
  - **referral_domain** (String) - Referral Domain.
  - **source** (String) - Source.
  - **tracking_code** (String) - Tracking code.
  - **custom_fields** (Array) - Array of custom fields as JSON objects, if any.
  - **registered_at** (String) - When the person is registered to a webinar.

#### Response Example
```json
{
  "registrations": [
    {
      "email": "example.user1@bigmarker.com",
      "first_name": "Example",
      "last_name": "user"
    },
    {
      "email": "another.registrant2@bigmarker.com",
      "first_name": "Another",
      "last_name": "Registrant"
    }
  ]
}
```

### Error Response
- **Unauthorized** (401) - {\"error\":\"Missing or invalid API key.\"}
- **Channel Permission Denied** (403) - {\"error\":\"You don’t have access to this channel\"}
```

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

### Create Subchannel with cURL

Source: https://docs.bigmarker.com/index

Creates a new subchannel under an existing channel using a cURL POST request. Requires an API key and JSON payload with channel details. Returns details of the newly created subchannel.

```bash
curl 'https://www.bigmarker.com/api/v1/channels' -i -X POST -H "API-KEY:xxxxxx" -H "Content-Type:application/json" -d '{"master_channel_id": "your_channel_id","": ""}'
```