Event group users

>>>

GET /api/v4/event_group_users
List Event Group Users

Event Groups Users associated with your company

Examples

{
  "total_records": integer,
  "page_number": integer,
  "data": [
    {
      "id": integer,
      "user_group_id": integer,
      "user_id": integer,
      "user_email": string,
      "is_text": boolean,
      "is_video": true,
      "is_chat": boolean,
      "is_disallow_transcript_save": boolean,
      "product_description": string,
      "created_at": datetime,
      "updated_at": datetime,
      "is_cameo": boolean,
      "access_token": string,
      "invited_at": datetime,
      "first_invited_at": datetime
    },
    ...
  ]
}

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
user_group_id
optional

User Group ID (Event Group ID, polymorphic tables)

Validations:

  • Must be a Integer
>>>

GET /api/v4/event_group_users/:id
Find Event Group User

Returns all attributes of a Event Group User

Errors

Code Description
404 Not Found

Examples

{
  "id": integer,
  "user_group_id": integer,
  "user_id": integer,
  "user_email": string,
  "is_text": boolean,
  "is_video": true,
  "is_chat": boolean,
  "is_disallow_transcript_save": boolean,
  "product_description": string,
  "created_at": datetime,
  "updated_at": datetime,
  "is_cameo": boolean,
  "access_token": string,
  "invited_at": datetime,
  "first_invited_at": datetime
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

Event Group User ID

Validations:

  • Must be a Integer
>>>

POST /api/v4/event_group_users
Create Event Group User

Create an event group user

Errors

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

Examples

{
  "id": integer,
  "user_group_id": integer,
  "user_id": integer,
  "user_email": string,
  "is_text": boolean,
  "is_video": true,
  "is_chat": boolean,
  "is_disallow_transcript_save": boolean,
  "product_description": string,
  "created_at": datetime,
  "updated_at": datetime,
  "is_cameo": boolean,
  "access_token": string,
  "invited_at": datetime,
  "first_invited_at": datetime
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
user_group_id
required

Event Group ID

Validations:

  • Must be a Integer
user_email
required

User email address

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_group_users/:id
Update Event Group User

Update an Event Group User

Errors

Code Description
404 Not Found

Examples

{
  "id": integer,
  "user_group_id": integer,
  "user_id": integer,
  "user_email": string,
  "is_text": boolean,
  "is_video": true,
  "is_chat": boolean,
  "is_disallow_transcript_save": boolean,
  "product_description": string,
  "created_at": datetime,
  "updated_at": datetime,
  "is_cameo": boolean,
  "access_token": string,
  "invited_at": datetime,
  "first_invited_at": datetime
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

Event Group User ID

Validations:

  • Must be a Integer
user_email
required

User email address

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.
>>>

GET /api/v4/event_group_users/:id/link
URL to access Event

Also see GET /v4/event_group_users/:id/send_email.

Errors

Code Description
404 Not Found

Examples

{
  "link": string
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

Event Group User ID

Validations:

  • Must be a Integer
>>>

GET /api/v4/event_group_users/:id/send_email
Send Email to Event Group User

Also see GET /v4/event_group_users/:id/link.

Errors

Code Description
404 Not Found

Examples

{
  "message": "Email sent successfully"
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

Event Group User ID

Validations:

  • Must be a Integer
>>>

DELETE /api/v4/event_group_users/:id
Delete Event Group User

Deletes an event group user

Errors

Code Description
404 Event Group User not found

Examples

{
  "id": 18696,
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
id
required

ID of the Event Group User

Validations:

  • Must be a Integer