NAV
cURL

Welcome to BigMarker Integration API Doc

The BigMarker API allows you to manage your your channel and conferences of your channel. With the BigMarker API you can:

The BigMarker API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and HTTP response codes that indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients, and we support cross-origin resource sharing to allow you to interact securely with our API from a client-side web application. JSON will be returned in all responses from the API, including errors.

Authentication

Login

To make any BigMarker API call, you must first get your BigMarker API-KEY. Go to your user’s settings page to request an API key. You can then use this login API call to retrieve your API-KEY. After authentication is complete, please store the returned api_token for future requests as your API-KEY. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.

Login example

curl -i -X POST --data "email=youremail@email.com&password=yourpassword" https://www.bigmarker.com/api/v1/members/login

The above command returns JSON structured like this:

[{"api_token":"xxxxxx"}]

Make sure to replace youremail@email.com and yourpassword with your email and password.

Routing

https://www.bigmarker.com/api/v1/members/login

Method

POST

Request Parameters

Parameter Type Required? Description
email String Required Email address you used to create your BigMarker account
password String Required Your password used with your email to log into BigMarker.com

Response Body Parameters

Parameter Type Description
api_token String API key for authentication.

Once you obtain your api_token, your api_token will be your API-KEY as authentication for all API calls by including it in the header. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.

Error Response

Status Type Message
401 authentication_error Authentication failed. Invalid email and/or password.
401 no_api_token_avilable You do not have a valid API token. Please request one by contacting support@bigmarker.com

Manage Conferences

Show Conference

You can use this API call to show information for a conference.

To get conference information

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

The above command returns JSON structured like this:

{
    "id": "xxxxxx1",
    "title": "Conference 1 Title",
    "conference_address": "https://www.bigmarker.com/channel_url/conference_1_url",
    "purpose": "To be great"
}

Routing

https://www.bigmarker.com/api/v1/conferences/conference_id

Method

GET

Request Parameters

Parameter Type Required Description Values
channel_id String Required Your conference ID.

Response Body Parameters

Parameter Type Description
id String Conference id
title String Conference title
max_attendance Integer Maximum number of attendees that can be hosted
purpose String Conference purpose
start_time String Conference start date and time
duration Integer Length of conference (in minutes)
conference_address String Conference URL
channel_id String Parent channel ID
dial_in_information Object Dial-in information, including dial-in number, id, and passcode
presenters Array List of presenters, with email, name, and member ID
privacy String Whether the conference is public or private
enable_registration_email Boolean Whether registration confirmation and reminder emails are enabled or disabled
show_reviews Boolean Whether reviews are displayed or hidden
enable_review_emails Boolean Whether review emails or enabled or disabled
can_view_poll_results Boolean Whether poll results are visible or hidden
enable_ie_safari Boolean True if attendees can enter a conference using Internet Explorer or Safari
sub_url String Sub URL of the conference. If the whole URL is www.bigmarker.com/channel/example-conference, the sub URL is “example-conference”.
exit_url String The site attendees are redirected to after the conference is over.
channel_admin_id String ID of the main conference presenter; defaults to the original channel admin.
enable_twitter Boolean Enables Twitter integration that displays all the Tweets from a specific Hashtag.
auto_invite_all_channel_members Boolean Enables automatic invites to all channel subscribers after 24 hours.
webhook_url String BigMarker will send a POST request to this URL with new registration data.

If the conference has ended and a recording is available, the following parameters will also be returned:

Parameter Type Description
recording_url String URL of the recording file
recording_iframe String Embed code for the recording

Error Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
You do not have rights to get conferences for channel 403 {“error”:“You don’t have access to this Channel”}
URL Error 404 {“error”:“Channel Not Found!”}

List Conferences

You can use this API call to get all future conferences from all of your channels.

To get all conferences belonging to all of your channels.

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

The above command returns JSON structured like this:

[
  {
    "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"
    }
]

Routing

https://www.bigmarker.com/api/v1/conferences/

Method

GET

Request Parameters

Parameter Type Description
API-KEY String Put api_token in the header

Response Body Parameters

Parameter Type Description
conferences Array Array of conferences

Each conference has the following parameters:

Parameter Type Description
id String Conference id
title String Conference title
max_attendance Integer Maximum number of attendees that can be hosted
purpose String Conference purpose
start_time String Conference start date and time
duration Integer Length of conference (in minutes)
conference_address String Conference URL
channel_id String Parent channel ID
dial_in_information Object Dial-in information, including dial-in number, id, and passcode
presenters Array List of presenters, with email, name, and member ID

Error Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
URL Error 404 {“error”:“Not Found!”}

Creating a Conference

To create a new conference for channel.


 curl 'https://www.bigmarker.com/api/v1/conferences' -i -X POST -H "API-KEY:xxxxxx" -H "Content-Type:application/json" -d '{"channel_id": "your_channel_id","title": "This is your conference title"}'

The above command returns JSON structured like this:


  {
    "id": "xxxxxx",
    "title": "Conference 1 Title",
    "conference_address": "https://www.bigmarker.com/channel_url/conference_1_url",
    "max_attendance": 100,
    "purpose": "To be great"
  }

You can use this API call to create a new conference for your channel.

Routing

https://www.bigmarker.com/api/v1/conferences

Method

POST

Request Parameters

Parameter Type Required Description
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.
start_time String Required The start time of your conference
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”.
exit_url String Optional The site attendees are redirected to after the conference is over.
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)’
purpose String Optional A description of your conference
channel_admin_id String Optional ID of the main conference presenter; defaults to the original channel admin.
room_logo String Optional A URL to the image to the room logo
room_sub_title String Optional Sub title for room.
duration_minutes String Optional Duration of the event in minutes. Range 1 to 240 minutes. Default is 60 minutes.
conference_copy_id String Optional The ID from the conference to be copied
enable_dial_in Boolean Optional True if conference dial-in should be enabled, defaults to false if conference dial-in should be disabled.
privacy String Optional Defaults to 'public’ if the event is to be listed publicly, 'private’ if the event should be kept private.
send_reminder_emails_to_presenters Boolean Optional Defaults to true to send reminder emails to admin and presenters of this conference.
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_cancellation_email Boolean Optional Defaults to true to notify all registrants that a conference was cancelled. Set this to false to prevent these notifications.
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.
auto_invite_all_channel_members Boolean Optional Enables automatic invites to all channel subscribers after 24 hours. Defaults to true.
background_image_url String Optional URL of conference background image. Recommended size is 1920 by 640.
webhook_url String Optional URL to send new conference registration info to.

Response Body Parameters

Parameter Type Description
id String Conference id
title String Conference title
max_attendance Integer Maximum number of attendees that can be hosted
purpose String Conference purpose
start_time String Conference start date and time
duration Integer Length of conference (in minutes)
conference_address String Conference URL
channel_id String Parent channel ID
dial_in_information Object Dial-in information, including dial-in number, id, and passcode
presenters Array List of presenters, with email, name, and member ID
privacy String Whether the conference is public or private
enable_registration_email Boolean Whether registration confirmation and reminder emails are enabled or disabled
show_reviews Boolean Whether reviews are displayed or hidden
enable_review_emails Boolean Whether review emails or enabled or disabled
can_view_poll_results Boolean Whether poll results are visible or hidden
enable_ie_safari Boolean True if attendees can enter a conference using Internet Explorer or Safari
sub_url String Sub URL of the conference. If the whole URL is www.bigmarker.com/channel/example-conference, the sub URL is “example-conference”.
exit_url String The site attendees are redirected to after the conference is over.
channel_admin_id String ID of the main conference presenter; defaults to the original channel admin.
enable_twitter Boolean Enables Twitter integration that displays all the Tweets from a specific Hashtag.
auto_invite_all_channel_members Boolean Enables automatic invites to all channel subscribers after 24 hours.
webhook_url String BigMarker will send a POST request to this URL with new registration data.

Error Response

Status Type Message
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.

Update a Conference

To update a conference from your channel.


 curl 'https://www.bigmarker.com/api/v1/conferences/{conference_id}' -i -X PUT -H "API-KEY:xxxxxx"
 -H "Content-Type:application/json"
 -d '{"title": "Lead Generation 101", "purpose":"How to generate leads with great content"}'

The above command returns JSON structured like this:

  {
    "id": "xxxxxx",
    "title": "Conference Title",
    "purpose": "Conference description and purpose",
    "start_time": "2015-11-01 14:00",
    "conference_address": "https://www.bigmarker.com/channel_url/conference_url"
  }

You can use this API call to update a conference for your channel.

Routing

https://www.bigmarker.com/api/v1/{:conference_id}

Method

PUT

Request Parameters

Parameter Type Required Description
conference_id String Required The ID of the conference you are updating. You can get this ID from list conferences API call
title String Required The title of your conference, maximum length 100 characters.
start_time String Required The start time of your conference
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”.
exit_url String Optional The site attendees are redirected to after the conference is over.
time_zone String Optional The time zone of your start time. Please visit the Time Zones section for a list of acceptable values.
purpose String Optional A description of your conference
channel_admin_id String Optional ID of the main conference presenter; defaults to the original channel admin.
room_logo String Optional A URL to the image to the room logo
room_sub_title String Optional Sub title for room.
duration_minutes String Optional Duration of the event in minutes. Range 1 to 240 minutes.
enable_dial_in Boolean Optional True if conference dial-in should be enabled, false if conference dial-in should be disabled.
privacy String Optional Set to ‘public’ if the event is to be listed publicly, 'private’ if the event should be kept private.
send_reminder_emails_to_presenters Boolean Optional Defaults to true to send reminder emails to admin and presenters of this conference.
registration_conf_emails Boolean Optional 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_cancellation_email Boolean Optional Set to true to notify all registrants that a conference was cancelled. Set this to false to prevent these notifications.
show_reviews Boolean Optional True if reviews should be displayed, false if reviews should be hidden.
review_emails Boolean Optional True if review emails should be sent to attendees, false if review emails should be disabled.
poll_results Boolean Optional 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). Set to false to disable this feature.
enable_twitter Boolean Optional Enables Twitter integration that displays all the Tweets from a specific Hashtag.
auto_invite_all_channel_members Boolean Optional Enables automatic invites to all channel subscribers after 24 hours.
background_image_url String Optional URL of conference background image. Recommended size is 1920 by 640.
webhook_url String Optional URL to send new conference registration info to.

Response Body Parameters

Parameter Type Description
id String Conference id
title String Conference title
max_attendance Integer Maximum number of attendees that can be hosted
purpose String Conference purpose
sub_url String Sub URL of the conference. If the whole URL is www.bigmarker.com/channel/example-conference, the sub URL is “example-conference”.
exit_url String The site attendees are redirected to after the conference is over.
channel_admin_id String ID of the main conference presenter; defaults to the original channel admin.
start_time String Conference start date and time
duration Integer Length of conference (in minutes)
conference_address String Conference URL
channel_id String Parent channel ID
dial_in_information Object Dial-in information, including dial-in number, id, and passcode
presenters Array List of presenters, with email, name, and member ID
privacy String Whether the conference is public or private
enable_registration_email Boolean Whether registration confirmation and reminder emails are enabled or disabled
show_reviews Boolean Whether reviews are displayed or hidden
enable_review_emails Boolean Whether review emails or enabled or disabled
can_view_poll_results Boolean Whether poll results are visible or hidden
enable_ie_safari Boolean True if attendees can enter a conference using Internet Explorer or Safari
enable_twitter Boolean Enables Twitter integration that displays all the Tweets from a specific Hashtag.
auto_invite_all_channel_members Boolean Enables automatic invites to all channel subscribers after 24 hours.
webhook_url String BigMarker will send a POST request to this URL with new registration data.

Error Response

Type Status Message
You do not have permission to retrieve conferences from this channel 403 {“error”:“You do not have access to this Channel”}

Delete a Conference

You can use this API call to delete a conference in your channel.

To delete a conference

curl -i -X DELETE -H "API-KEY:xxxxxx"  https://www.bigmarker.com/api/v1/conferences/:conference_id

Routing

https://www.bigmarker.com/api/v1/conferences/:conference_id

Method

DELETE

Request Parameters

Parameter Type Required Description Values
conference_id String Required Your conference ID.

Error Response

Status Type Message
401 channel_permission_denied You do not have permission to access this channel.
404 conference_not_found The conference you are requesting is not found.

Show Conference Attendees

To get a list of conference attendees.

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

The above command returns JSON structured like this:

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

Routing

https://www.bigmarker.com/api/v1/conferences/:conference_id/attendees

Method

GET

Response Body Parameters

Parameter Type Description
attendees Array List of attendees

Each attendee will have the following parameters:

Parameter Type Description
email String Attendee email
first_name String Attendee first name
last_name String Attendee last name
entered_at String Time that attendee entered the conference
leaved_at String Time that attendee left the conference
total_duration String Number of seconds attendee was in conference
engaged_duration String Number of seconds attendee was engaged in conference
chats_count Integer Number of chats attendees sent
qas_count Integer Number of questions attendee posted
polls_count Integer Number of polls attendee answered
polls Array Polls answered by attendee
questions Array Questions asked by attendee
handouts Array Handouts downloaded by attendee

Error Response

Type Status Message
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 conference has not ended yet.”}

Entering a Conference

To create a new conference for channel.


 curl 'https://www.bigmarker.com/api/v1/conferences/enter' -i -X POST -H "API-KEY:xxxxxx" -H "Content-Type:application/json"
 -d '{"id": "your_conference_id","attendee_name": "John Doe", "attendee_email":"email@email.com", "role":"attendee", "exit_uri":"https://www.yourwebsite.com"}'

The above command returns JSON structured like this:


  {
    "enter_token": "xxxxxx",
    "enter_uri": "https://www.bigmarker.com/enter_url"    
  }

You can use this API call to enter a conference. This will allow you to by pass the BigMarker conference landing page and enter the conference room directly. When used with custom branding feature, this API call is very powerful as you can integrate the BigMarker conference room directly into your website as your own conferencing platform.

Routing

https://www.bigmarker.com/api/v1/conferences/enter

Method

POST

Request Parameters

Parameter Type Required Description Values
id String Required The ID of the conference you are trying to enter
attendee_name String Required The name of the attendee that would show up in the conference room.
attendee_email String Required The email of the attendee. Providing email will allow the attendee to receive emails when the conference recording is posted.
role String Optional Passing the presenter value will give the person presenter rights and access to the admin control panel within the conference. Attendee (default), presenter
exit_uri String Optional A description of your conference

Response Body Parameters

Parameter Type Description
enter_token String Token for entering the conference
enter_uri String Link for member to enter the conference

Error Response

Status Type Message
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.
401 premium_channel_required This channel does not allow entering of the conference via API, please use the conference page or upgrade your account.
400 conference_setting_up The server for this conference is setting up. Please wait a few minutes and try again.
400 conference_ended This conference has ended
400 conference_not_open_for_presenter This conference is currently not open. Presenters can enter the conference 30 minutes prior to the conference start time.
400 conference_not_open_for_attendee This conference is currently not open. Attendees can enter the conference 15 minutes prior to the conference start time.

Conference Registrations

Show Conference Registrants

To get all registrants for a conference.

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

The above command returns a list of conference registrants.


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

Routing

https://www.bigmarker.com/api/v1/conferences/registrations/:conference_id

Method

GET

Request Parameters

Parameter Type Required Description Values
channel_id String Required Your conference ID.

Response Body Parameters

Parameter Type Description
email String Registrant email
first_name String Registrant’s first name
last_name String Registrant’s last name

Error Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
Channel Permission Denied 403 {“error”:“You don’t have access to this channel”}

Register a User to a Conference

You can use this API call to register a person to your existing conferences in your channel.

curl https://www.bigmarker.com/api/v1/conferences/register -i -X PUT -H "API-KEY:xxxxxx"
--data "id=xxxxxx&email=emailaddress@email.com&first_name=John&last_name=Doe"

The above command returns JSON structure that contains the URL the registered user can use to enter the conference


  {
    "conference_url": "https://www.bigmarker.com/your_channel_id/your_conference_id"
  }

Routing

https://www.bigmarker.com/api/v1/conferences/register

Method

PUT

Request Parameters

Parameter Type Required? Description
id String Required Conference ID of the conference to register
email String Required Registrant’s email
first_name String Required Registrant’s first name
last_name String Required Registrant’s last name
temporary_password String Optional Temporary password for registrant

Response Body Parameters

Parameter Type Description
conference_url String Link to enter the conference for registrant

Error Response

Status Type Message
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.

Unregister a User From a Conference

curl https://www.bigmarker.com/api/v1/conferences/register
-i -X DELETE  -H "API-KEY:xxxxxx"
--data "id=xxxxxx&email=email@email.com"

Routing

https://www.bigmarker.com/api/v1/conferences/register

Method

DELETE

Request Parameters

Parameter Type Required? Description
id String Required The conference ID that you like to unregister the user from
email String Required The email address of the user that you like to unregister from the conference

Error Response

Status Type Message
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.

Manage Channels

Show Channel

You can use this API call to show information for a channel.

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

The above command returns JSON structured like this:

{
    "channel_id": "xxxxxx1",    
    "channel_url": "https://www.bigmarker.com/channel1_url",
    "name": "Channel 1 Name",
    "overview": "Channel 1 Overview"
}

Routing

https://www.bigmarker.com/api/v1/channels/:channel_id

Method

GET

Request Parameters

Parameter Type Description
API-KEY String Put api_token in the header

Response Body Parameters

Parameter Type Description
channel_id String Channel ID
channel_url String Channel URL
name String Channel name
overview String Channel overview
description String Channel description

Error Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
URL Error 404 {“error”:“Not Found!”}

List Channels

You can use this API call to get all of your channels.

To get all of your channels.

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

The above command returns JSON structured like this:

{
  "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"
    }]
}

Routing

https://www.bigmarker.com/api/v1/channels/

Method

GET

Request Parameters

Parameter Type Description
API-KEY String Put api_token in the header

Response Body Parameters

Parameter Type Description
channels Array List of all channels

Each channel has the following parameters:

Parameter Type Description
channel_id String Channel ID
channel_url String Channel URL
name String Channel name
overview String Channel overview
description String Channel description

Error Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
URL Error 404 {“error”:“Not Found!”}

List Channel Conferences

You can use this API call to get all future conferences from one of your channels.

To get all conferences belonging to a channel

 curl -i -H "API-KEY:xxxxxx" 'https://www.bigmarker.com/api/v1/channel/:channel_url/conferences'

The above command returns JSON structured like this:

{
  "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"
    }]
}

Routing

https://www.bigmarker.com/api/v1/channel/:channel_url/conferences

Method

GET

Request Parameters

Parameter Type Required Description Values
channel_url String Required Your channel URL.
timing String Optional The time frame the list of conferences should be in future (default), all, past
page Integer Optional The page number of the list Defaults to 1
per_page Integer Optional How many conferences per page to fetch Defaults to 25

Response Body Parameters

Parameter Type Description
conferences Array List of conferences in the channel

Each conference has the following parameters:

Parameter Type Description
id String Conference id
title String Conference title
max_attendance Integer Maximum number of attendees that can be hosted
purpose String Conference purpose
start_time String Conference start date and time
duration Integer Length of conference (in minutes)
conference_address String Conference URL
channel_id String Parent channel ID
dial_in_information Object Dial-in information, including dial-in number, id, and passcode
presenters Array List of presenters, with email, name, and member ID

Error Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
You do not have rights to get conferences for channel 403 {“error”:“You don’t have access to this Channel”}
URL Error 404 {“error”:“Channel Not Found!”}

Create a Subchannel

You can use this API call to create a channel under an already existing channel that you administer.

To create a subchannel.

 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","": ""}'

The above command returns JSON structured like this:

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

Routing

https://www.bigmarker.com/api/v1/channels/

Method

POST

Request Parameters

Parameter Type Required Description
master_channel_id String Required ID of the parent channel
channel_name String Required The name of your subchannel
channel_url String Required The ID of your subchannel to be used in the URL
organizer_email String Required The email of the subchannel organizer
organizer_first_name String Optional The first name of the subchannel organizer
organizer_last_name String Optional The last name of the subchannel organizer
organizer_temporary_password String Optional A temporary password for the subchannel organizer
background_image_url String Optional URL of background image. Recommended dimensions are 1456 by 360.

Response Body Parameters

Parameter Type Description
channel_id String Channel ID
channel_url String Channel URL
name String Channel name
overview String Channel overview
description String Channel description

Error Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
URL Error 404 {“error”:“Not Found!”}

List Subchannels

You can use this API call to get all of the subchannels under a certain channel.

To get all of the subchannels for a channel.

 curl -i -H "API-KEY:xxxxxx"  https://www.bigmarker.com/api/v1/channels/sub_channels/channel_url

The above command returns JSON structured like this:

{
  "channels":
  [{
    "channel_id": "xxxxxx1",    
    "channel_url": "https://www.bigmarker.com/subchannel1_url",
    "name": "Subchannel 1 Name",
    "overview": "Subchannel 1 Overview"
  },
  {
    "channel_id": "xxxxxx2",    
    "channel_url": "https://www.bigmarker.com/subchannel2_url",
    "name": "Subchannel 2 Name",
    "overview": "Subchannel 2 Overview"
    }]
}

Routing

https://www.bigmarker.com/api/v1/channels/sub_channels/channel_url

Method

GET

Request Parameters

Parameter Type Description
channel_url String The ID of the parent channel
API-KEY String put in request head

Response Body Parameters

Parameter Type Description
channels Array List of subchannels in channel

Each subchannel has the following parameters:

Parameter Type Description
channel_id String Channel ID
channel_url String Channel URL
name String Channel name
overview String Channel overview
description String Channel description

Error Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
URL Error 404 {“error”:“Not Found!”}

Conference Presenters

Add a Presenter

You can use this API call to add a presenter to a conference.

To add a presenter to a conference.


 curl 'https://www.bigmarker.com/api/v1/presenters' -i -X POST -H "API-KEY:xxxxxx" -H "Content-Type:application/json" -d '{"xx": "xx"}'

The above command returns JSON structured like this:


  {
    "member_id": "xxxxxx",
    "conference_id": "xxxxxx",
    "first_name": "Example",
    "last_name": "Presenter",
    "email": "example.presenter@bigmarker.com"
  }

Routing

https://www.bigmarker.com/api/v1/presenters

Method

POST

Request Parameters

Parameter Type Required Description
conference_id String Required The conference ID that you want to add this presenter to.
name String Required The name of the presenter, as it appears in the conference.
photo_url String Required The URL of presenter’s profile image.
presenter_email String Required The email of the presenter to be added.
presenter_first_name String Required The presenter’s first name, optional if presenter already exists.
presenter_last_name String Required The presenter’s last name, optional if presenter already exists.
presenter_temporary_password String Required Temporary password for the presenter, optional if presenter already exists.
bio String Optional The presenter’s bio.
title String Optional The presenter’s title.
can_manage Boolean Optional Can the presenter manage the event?
is_moderator Boolean Optional Is the presenter the moderator and can access the host control panel?
send_email_invite Boolean Optional Defaults to true if email invites should be sent, false if emails should not be sent.
add_to_channel_subscriber_list Boolean Optional Defaults to true if presenter should be added to channel, false if presenter should not be added.

Response Body Parameters

Parameter Type Description
member_id String Member ID of presenter
conference_id String Conference ID
first_name String Presenter first name
last_name String Presenter last name
email String Presenter email

Error Response

Status Type Message
400 bad_request The presenter email you provided is not in our system. To create a new presenter profile, please provide the presenter’s first name, last name, and temporary password.
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.

Update a Presenter

You can use this API call to update an existing presenter in a conference.

To update a presenter in a conference.


 curl 'https://www.bigmarker.com/api/v1/presenters/{:presenter_id}' -i -X PUT -H "API-KEY:xxxxxx" -H "Content-Type:application/json" -d '{"xx": "xx"}'

The above command returns JSON structured like this:


  {
    "member_id": "xxxxxx",
    "conference_id": "xxxxxx",
    "first_name": "Example",
    "last_name": "Presenter",
    "email": "example.presenter@bigmarker.com"
  }

Routing

https://www.bigmarker.com/api/v1/presenters/{:presenter_id_id}

Method

PUT

Request Parameters

Parameter Type Required Description
presenter_email String optional The email of the presenter to be updated.
name String Optional The name of the presenter, as it appears in the conference.
photo_url String Optional The URL of presenter’s profile image.
presenter_first_name String Optional The presenter’s first name.
presenter_last_name String Optional The presenter’s last name.
presenter_temporary_password String Optional Temporary password for the presenter.
bio String Optional The presenter’s bio.
title String Optional The presenter’s title.
can_manage Boolean Optional Can the presenter manage the event?
is_moderator Boolean Optional Is the presenter the moderator and can access the host control panel?

Response Body Parameters

Parameter Type Description
member_id String Member ID of presenter
conference_id String Conference ID
first_name String Presenter first name
last_name String Presenter last name
email String Presenter email

Error Response

Status Type Message
400 bad_request The presenter does not exist - plase add the presenter using the proper API call
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.

Remove a Presenter

You can use this API call to remove an existing presenter from a conference.

To remove a presenter from a conference.


 curl 'https://www.bigmarker.com/api/v1/presenters' -i -X DELETE -H "API-KEY:xxxxxx" -H "Content-Type:application/json" -d '{"xx": "xx"}'

Routing

https://www.bigmarker.com/api/v1/presenters/{presenter_id}

Method

DELETE

Required Parameter

Parameter Type Required Description
presenter_id String Required The ID of the presenter

Error Response

Status Type Message
400 bad_request The presenter does not exist - plase add the presenter using the proper API call
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.

List Conferences

You can use this API call to list all of the conferences for a presenter.

To list the conferences for a presenter.


 curl 'https://www.bigmarker.com/api/v1/presenters/xxxxxxx/list_conferences' -i -X GET -H "API-KEY:xxxxxx"

The above command returns JSON structured like this:

{
  "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"
    }]
}

Routing

https://www.bigmarker.com/api/v1/presenters/{presenter_id}/list_conferences

Method

GET

Request Parameters

Parameter Type Required Description
member_id String Required The ID of the presenter.
channel_id String Required The ID of the channel.

Response Body Parameters

Parameter Type Description
conferences Array List of conferences

Each conference has the following parameters:

Parameter Type Description
id String Conference id
title String Conference title
max_attendance Integer Maximum number of attendees that can be hosted
purpose String Conference purpose
start_time String Conference start date and time
duration Integer Length of conference (in minutes)
conference_address String Conference URL
channel_id String Parent channel ID
dial_in_information Object Dial-in information, including dial-in number, id, and passcode
presenters Array List of presenters, with email, name, and member ID

Error Response

Status Type Message
400 bad_request The member does not exist!
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.

Manage Channel Admins

Add Channel Admin

You can use this API call to add an admin to a channel.

To add an admin to a channel.

 curl 'https://www.bigmarker.com/api/v1/channel_admins' -i -X POST -H "API-KEY:xxxxxx" -H "Content-Type:application/json" 
 -d '{"channel_id" : "your_channel_id", "email":"email@yourdomain.com", 
 "first_name": "John", "last_name": "Doe", "temporary_password":"goodpassword", 
 "photo_url":"http://clipartix.com/wp-content/uploads/2016/05/Smiley-face-0-ideas-about-smileys-on-manchmal-hab-dich-lieb-clipart.jpg",
 "bio": "Hi! This is my bio."}'

The above command returns JSON structured like this:

{
    "admin_id": "new admin id",
    "first_name": "John",
    "last_name": "Doe",
    "bio": "Hi! This is my bio."
}

Routing

https://www.bigmarker.com/api/v1/channel_admins

Method

POST

Request Parameters

Parameter Type Required Description
channel_id String Required ID of the channel
email String Required The email of the new channel admin
first_name String Optional The first name of the new channel admin
last_name String Optional The last name of the new channel admin
temporary_password String Optional A temporary password for the new channel admin
photo_url String Optional The URL to the photo for the admin
title String Optional Admin title
bio String Optional Admin bio

Response Body Parameters

Parameter Type Description
admin_id String Admin ID
first_name String Admin first name
last_name String Admin last name
bio String Admin bio

Error Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
URL Error 404 {“error”:“Not Found!”}

Update Channel Admin

You can use this API call to edit and update a channel admin.

To edit an admin to a channel.

 curl 'https://www.bigmarker.com/api/v1/channel_admins/xxxxxxx' -i -X PUT -H "API-KEY:xxxxxx" -H "Content-Type:application/json" 
 -d '{ "first_name": "John", "last_name": "Doe",  
 "photo_url":"http://clipartix.com/wp-content/uploads/2016/05/Smiley-face-0-ideas-about-smileys-on-manchmal-hab-dich-lieb-clipart.jpg",
 "bio": "Hi! This is my bio."}'

The above command returns JSON structured like this:

{
    "admin_id": "admin_id",
    "first_name": "John",
    "last_name": "Doe",
    "bio": "Hi! This is my bio."
}

Routing

https://www.bigmarker.com/api/v1/channel_admins/:admin_id

Method

PUT

Request Parameters

Parameter Type Required Description
admin_id String Required ID of the channel
first_name String Optional The first name of the new channel admin
last_name String Optional The last name of the new channel admin
photo_url String Optional The URL to the photo for the admin. To remove the photo, pass the value ‘delete’ to this parameter.
title String Optional Admin title
bio String Optional Admin bio

Response Body Parameters

Parameter Type Description
admin_id String Admin ID
first_name String Admin first name
last_name String Admin last name
bio String Admin bio

Error Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
URL Error 404 {“error”:“Not Found!”}

Time Zones

Please use the following time zones values in creating and editing conferences.

Time zone
International Date Line West
Midway Island
American Samoa
Hawaii
Alaska
Pacific Time (US & Canada)
Tijuana
Mountain Time (US & Canada)
Arizona
Chihuahua
Mazatlan
Central Time (US & Canada)
Saskatchewan
Guadalajara
Mexico City
Monterrey
Central America
Eastern Time (US & Canada)
Indiana (East)
Bogota
Lima
Quito
Atlantic Time (Canada)
Caracas
La Paz
Santiago
Newfoundland
Brasilia
Buenos Aires
Georgetown
Greenland
Mid-Atlantic
Azores
Cape Verde Is.
Dublin
Edinburgh
Lisbon
London
Casablanca
Monrovia
UTC
Belgrade
Bratislava
Budapest
Ljubljana
Prague
Sarajevo
Skopje
Warsaw
Zagreb
Brussels
Copenhagen
Madrid
Paris
Amsterdam
Berlin
Bern
Rome
Stockholm
Vienna
West Central Africa
Bucharest
Cairo
Helsinki
Kyiv
Riga
Sofia
Tallinn
Vilnius
Athens
Istanbul
Minsk
Jerusalem
Harare
Pretoria
Moscow
St. Petersburg
Volgograd
Kuwait
Riyadh
Nairobi
Baghdad
Tehran
Abu Dhabi
Muscat
Baku
Tbilisi
Yerevan
Kabul
Ekaterinburg
Islamabad
Karachi
Tashkent
Chennai
Kolkata
Mumbai
New Delhi
Kathmandu
Astana
Dhaka
Sri Jayawardenepura
Almaty
Novosibirsk
Rangoon
Bangkok
Hanoi
Jakarta
Krasnoyarsk
Beijing
Chongqing
Hong Kong
Urumqi
Kuala Lumpur
Singapore
Taipei
Perth
Irkutsk
Ulaan Bataar
Seoul
Osaka
Sapporo
Tokyo
Yakutsk
Darwin
Adelaide
Canberra
Melbourne
Sydney
Brisbane
Hobart
Vladivostok
Guam
Port Moresby
Magadan
Solomon Is.
New Caledonia
Fiji
Kamchatka
Marshall Is.
Auckland
Wellington
Nuku'alofa
Tokelau Is.
Samoa

Errors

Error Code Meaning
400 Bad Request – The format of your request is not acceptable
401 Unauthorized – Your API key is invalid
403 Forbidden – The channel you are trying to access is not accessible to you
406 Not Acceptable – You requested a format that isn’t json
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable – We’re temporarily offline for maintenance. Please try again later.