Create Online Conference Attendees

Required permissions: online_conferences.update.*

POST /online_conferences/{online_conference_id}/attendees

Create Online Conference Attendees

cURL

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

import requests

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

payload = [
    {
        "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([{email: '[e-mail]', name: '<string>'}])
};

fetch('https://{primary_domain}/api/public/v2.0/online_conferences/{online_conference_id}/attendees', 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/{online_conference_id}/attendees",
  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([
    [
        '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/{online_conference_id}/attendees"

	payload := strings.NewReader("[\n  {\n    \"email\": \"[e-mail]\",\n    \"name\": \"<string>\"\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/{online_conference_id}/attendees")
  .header("X-Access-Key-Id", "<api-key>")
  .header("X-Access-Key-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"email\": \"[e-mail]\",\n    \"name\": \"<string>\"\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

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

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  {\n    \"email\": \"[e-mail]\",\n    \"name\": \"<string>\"\n  }\n]"

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

200

{
  "message": "<string>",
  "data": [
    {
      "id": 123,
      "online_conference_id": 123,
      "email": "[e-mail]",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "attendee_id": 123,
      "name": "<string>",
      "joined_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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

"Invalid or missing access key."

"Cannot exceed maximum attendee count."

"Too many requests."

"An unexpected error occurred."

Authorizations

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

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

Path Parameters

online_conference_id · integer · required

Body

application/json

Maximum array length: 5

email · string<email> · required

Maximum string length: 255

name · string | null

Maximum string length: 255

Response

200

application/json

message · string · required

data · object[] · required

A list of Online Conference Attendee resource objects.

Show child attributes