Online Conferences
- GETList Online Conferences
- POSTCreate Online Conference
- GETGet Online Conference
- DELDelete Online Conference
- PATCHUpdate Online Conference
- GETList Online Conference Attendees
- POSTCreate Online Conference Attendees
- DELDelete Online Conference Attendee
- POSTGenerate Online Conference Attendee Join Token
- GETList Online Conference Recordings
- GETGet Online Conference Recording Temporary URL
Online Conferences
Create Online Conference
Required permissions: online_conferences.create.*
POST
/
online_conferences
Copy
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,
"backer_event_id": 123,
"public_id": "<string>",
"title": "<string>",
"is_public": true,
"online_conference_attendees": [
{
"name": "<string>",
"email": "jsmith@example.com"
}
]
}'
Copy
{
"message": "<string>",
"data": {
"id": 123,
"online_conference_account_id": 123,
"backer_event_id": 123,
"public_id": "<string>",
"title": "<string>",
"is_public": true,
"is_occurred": true,
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
Body
application/json
Response
200
application/json
The response is of type object
.
Copy
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,
"backer_event_id": 123,
"public_id": "<string>",
"title": "<string>",
"is_public": true,
"online_conference_attendees": [
{
"name": "<string>",
"email": "jsmith@example.com"
}
]
}'
Copy
{
"message": "<string>",
"data": {
"id": 123,
"online_conference_account_id": 123,
"backer_event_id": 123,
"public_id": "<string>",
"title": "<string>",
"is_public": true,
"is_occurred": true,
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
Assistant
Responses are generated using AI and may contain mistakes.