Skip to main content
POST
/
online_conferences
Create Online Conference
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": "jsmith@example.com",
      "name": "<string>"
    }
  ]
}
'
{
  "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"
  }
}

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

Response

​
message
string
required
​
data
object
required

An Online Conference resource object.