Create Online Conference

Required permissions: online_conferences.create.*

POST /online_conferences

Try it

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

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

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

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

online_conference_attendees. email · string<email> · required

Maximum string length: 255

online_conference_attendees. name · string | null

Maximum string length: 255

Response

200

application/json

message · string · required

data · object · required

An Online Conference resource object.

Show child attributes

data. id · integer<int64> · required

data. online_conference_account_id · integer<int64> · required

data. public_id · string · required

data. title · string · required

Maximum string length: 255

data. is_public · boolean · required

data. deleted_at · string<date-time> | null · required

data. created_at · string<date-time> · required

data. updated_at · string<date-time> · required

data. backer_event_id · integer<int64> | null

data. is_occurred · boolean

data. started_at · string<date-time> | null

data. ended_at · string<date-time> | null