POST /api/v3/cameo_meetings
Create Cameo Meeting

Creates a Cameo Meeting

Errors

Code Description
300 Error creating Cameo Meeting
422 Unable to process request, see errors in response

Metadata

Example Request Params Format:
  name: Name for Cameo Meeting
  description: Description for Cameo Meeting
  internal_ref_num: 'job #1527483'
  witness_name: Some Person
  timezone: Eastern Time (US & Canada)
  starts_at_date: 05/04/2022
  starts_at_time: 01:15 PM
  ends_at_date: 05/04/2022
  ends_at_time: 02:15 PM
  users_attributes:
    '0':
      email: test_user@company.com
    '1':
      email: test_user@company.com

Examples

{
  "id": integer,
  "name": string,
  "description": text,
  "internal_ref_num": string,
  "timezone": string,
  "starts_at": datetime,
  "ends_at": datetime,
  "zoom_meeting_id": string,
  "created_by_id": integer,
  "created_at": datetime,
  "updated_at": datetime,
  "uuid": string,
  "canceled_at": datetime,
  "status": string,
  "confirmed_at": datetime,
  "reactivated_at": datetime,
  "is_unlicensed_notified": boolean,
  "unlicensed_notified_at": datetime,
  "is_licensed": boolean,
  "is_licensed_at": datetime,
  "zoom_log_starts_at": datetime,
  "zoom_log_ends_at": datetime,
  "witness_name": string,
  "zoom_meeting_uuid": string,
  "white_glove": boolean,
  "creator": {
    "email": string,
    "first_name": string,
    "last_name": string,
  },
  "users": [
    {
      "id": integer,
      "email": string,
      "invitation_sent_at": datetime,
    },
  ]
  "zoom_room": {
    "id": integer,
    "name": string,
  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
status
optional

Meeting Status. Default status is pending

Validations:

  • Must be one of: pending, confirmed.
zoom_room_id
optional

Zoom Room ID

Validations:

  • Must be a Integer
name
required

Case Name

Validations:

  • Must be a String
description
optional

Validations:

  • Must be a String
internal_ref_num
optional

Job Number

Validations:

  • Must be a String
witness_name
optional

Validations:

  • Must be a String
password
optional

Password for Cameo Meeting. Minimum 4 characters.

Validations:

  • Must be a Integer
starts_at_date
required

Starting Date of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
starts_at_time
required

Starting Time of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 1:00 PM
ends_at_date
required

Starting Date of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
ends_at_time
required

Starting Time of first CameoMeeting

Validations:

  • Must be a String


Metadata: 
- Example formatting
- 05/04/2022
time_zone
required

Validations:

  • Must be a String


Metadata: 
- Alaska
- Arizona
- Central Time (US & Canada)
- Eastern Time (US & Canada)
- Hawaii
- Mountain Time (US & Canada)
- Pacific Time (US & Canada)
white_glove
optional

White Glove Service

Validations:

  • Must be a String
users_attributes
required

CameoMeeting users

Validations:

  • Must be a Hash


Metadata: 
users_attributes:
  '0':
    email: test_user@company.com
  '1':
    email: test_user@company.com
users_attributes[index]
required

Index for user

Validations:

  • Must be a Hash
users_attributes[index][email]
required

Email for the user

Validations:

  • Must be a String