Event groups

>>>

GET /api/v4/event_groups
List Event Groups

Event Groups associated with your company

Examples

{
  "total_records": integer,
  "page_number": integer,
  "data": [
    {
      "id": integer,
      "event_id": integer,
      "name": string,
      "access_key": string,
      "is_text": boolean,
      "is_video": boolean,
      "is_chat": boolean,
      "is_disallow_transcript_save": boolean,
      "product_description": string,
      "deleted_at": datetime,
      "created_at": datetime,
      "updated_at": datetime,
      "is_cameo": boolean
    },
    ...
  ]
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
page_number
optional

Page Number

Validations:

  • Must be a Integer
event_id
optional

Event ID

Validations:

  • Must be a Integer
>>>

GET /api/v4/event_groups/:id
Find Event Group

Returns all attributes of a Event Group

Errors

Code Description
404 Not Found

Examples

{
  "id": integer,
  "event_id": integer,
  "name": string,
  "access_key": string,
  "is_text": boolean,
  "is_video": boolean,
  "is_chat": boolean,
  "is_disallow_transcript_save": boolean,
  "product_description": string,
  "deleted_at": datetime,
  "created_at": datetime,
  "updated_at": datetime,
  "is_cameo": boolean
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

Event Group ID

Validations:

  • Must be a Integer
>>>

POST /api/v4/event_groups
Create Event Group

Create an event group

Errors

Code Description
422 Unable to process request, see errors in response
404 Event Not Found

Examples

{
  "id": integer,
  "event_id": integer,
  "name": string,
  "access_key": string,
  "is_text": boolean,
  "is_video": boolean,
  "is_chat": boolean,
  "is_disallow_transcript_save": boolean,
  "product_description": string,
  "deleted_at": datetime,
  "created_at": datetime,
  "updated_at": datetime,
  "is_cameo": boolean
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
event_id
required

Event ID

Validations:

  • Must be a Integer
name
required

Name

Validations:

  • Must be a String
is_text
optional

Enable realtime text

Validations:

  • Must be one of: true, false.
is_video
optional

Enable video

Validations:

  • Must be one of: true, false.
is_chat
optional

Enable chat

Validations:

  • Must be one of: true, false.
is_disallow_transcript_save
optional

Disable transcript save

Validations:

  • Must be one of: true, false.
is_cameo
optional

Enable cameo

Validations:

  • Must be one of: true, false.
>>>

PATCH /api/v4/event_groups/:id
Update Event Group

Update an event schedule

Errors

Code Description
404 Not Found

Examples

{
  "id": integer,
  "event_id": integer,
  "name": string,
  "access_key": string,
  "is_text": boolean,
  "is_video": boolean,
  "is_chat": boolean,
  "is_disallow_transcript_save": boolean,
  "product_description": string,
  "deleted_at": datetime,
  "created_at": datetime,
  "updated_at": datetime,
  "is_cameo": boolean
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

Event Group ID

Validations:

  • Must be a Integer
name
required

Name

Validations:

  • Must be a String
is_text
optional

Enable realtime text

Validations:

  • Must be one of: true, false.
is_video
optional

Enable video

Validations:

  • Must be one of: true, false.
is_chat
optional

Enable chat

Validations:

  • Must be one of: true, false.
is_disallow_transcript_save
optional

Disable transcript save

Validations:

  • Must be one of: true, false.
is_cameo
optional

Enable cameo

Validations:

  • Must be one of: true, false.