Create Online Conference

Required permissions: online_conferences.create.*

POST /online_conferences

Create Online Conference

cURL

curl --request POST \
  --url https://{primary_domain}/api/public/v2.0/online_conferences \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key-Id: <api-key>' \
  --header 'X-Access-Key-Secret: <api-key>' \
  --data '
{
  "online_conference_account_id": 123,
  "public_id": "<string>",
  "title": "<string>",
  "is_public": true,
  "backer_event_id": 123,
  "online_conference_attendees": [
    {
      "email": "[e-mail]",
      "name": "<string>"
    }
  ]
}
'

import requests

url = "https://{primary_domain}/api/public/v2.0/online_conferences"

payload = {
    "online_conference_account_id": 123,
    "public_id": "<string>",
    "title": "<string>",
    "is_public": True,
    "backer_event_id": 123,
    "online_conference_attendees": [
        {
            "email": "[e-mail]",
            "name": "<string>"
        }
    ]
}
headers = {
    "X-Access-Key-Id": "<api-key>",
    "X-Access-Key-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Access-Key-Id': '<api-key>',
    'X-Access-Key-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    online_conference_account_id: 123,
    public_id: '<string>',
    title: '<string>',
    is_public: true,
    backer_event_id: 123,
    online_conference_attendees: [{email: '[e-mail]', name: '<string>'}]
  })
};

fetch('https://{primary_domain}/api/public/v2.0/online_conferences', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{primary_domain}/api/public/v2.0/online_conferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'online_conference_account_id' => 123,
    'public_id' => '<string>',
    'title' => '<string>',
    'is_public' => true,
    'backer_event_id' => 123,
    'online_conference_attendees' => [
        [
                'email' => '[e-mail]',
                'name' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Access-Key-Id: <api-key>",
    "X-Access-Key-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{primary_domain}/api/public/v2.0/online_conferences"

	payload := strings.NewReader("{\n  \"online_conference_account_id\": 123,\n  \"public_id\": \"<string>\",\n  \"title\": \"<string>\",\n  \"is_public\": true,\n  \"backer_event_id\": 123,\n  \"online_conference_attendees\": [\n    {\n      \"email\": \"[e-mail]\",\n      \"name\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Access-Key-Id", "<api-key>")
	req.Header.Add("X-Access-Key-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{primary_domain}/api/public/v2.0/online_conferences")
  .header("X-Access-Key-Id", "<api-key>")
  .header("X-Access-Key-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"online_conference_account_id\": 123,\n  \"public_id\": \"<string>\",\n  \"title\": \"<string>\",\n  \"is_public\": true,\n  \"backer_event_id\": 123,\n  \"online_conference_attendees\": [\n    {\n      \"email\": \"[e-mail]\",\n      \"name\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{primary_domain}/api/public/v2.0/online_conferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Access-Key-Id"] = '<api-key>'
request["X-Access-Key-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"online_conference_account_id\": 123,\n  \"public_id\": \"<string>\",\n  \"title\": \"<string>\",\n  \"is_public\": true,\n  \"backer_event_id\": 123,\n  \"online_conference_attendees\": [\n    {\n      \"email\": \"[e-mail]\",\n      \"name\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>",
  "data": {
    "id": 123,
    "online_conference_account_id": 123,
    "public_id": "<string>",
    "title": "<string>",
    "is_public": true,
    "deleted_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "backer_event_id": 123,
    "is_occurred": true,
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "<string>",
  "errors": {
    "attribute": [
      "The {attribute} field is required."
    ]
  }
}

"Invalid or missing access key."

"Too many requests."

"An unexpected error occurred."

Authorizations

X-Access-Key-Id · string · header · required

X-Access-Key-Secret · string · header · required

Body

application/json

online_conference_account_id · integer<int64> · required

public_id · string · required

Pattern: /^[a-zA-Z0-9-_]+$/

title · string · required

Maximum string length: 255

is_public · boolean · required

backer_event_id · integer<int64> | null

online_conference_attendees · object[]

Owner of OnlineConferenceAccount is automatically an attendee even if not specified. A User or Customer is automatically matched based on the Online Conference Attendee's provided email.

Maximum array length: 5

Show child attributes

Response

200

application/json

message · string · required

data · object · required

An Online Conference resource object.

Show child attributes