POST /api/v4/events
Create Event

Create an event

Will also create a child Event Schedule with values passed to starting_date and start_time

Errors

Code Description
422 Unable to process request, see errors in response

Examples

{
  "id": integer,
  "time_zone": string,
  "status": string,
  "notes": string,
  "title": string,
  "internal_ref_num": string,
  "deponent": string,
  "transcript_id": string,
  "created_at": datetime,
  "updated_at": datetime,
  "is_video_streamed": boolean,
  "is_text_streamed": boolean,
  "is_chat_enabled": boolean,
  "text_account_num": string,
  "reporter_name": string,
  "scheduler_case_id": integer,
  "is_teleconferenced": boolean,
  "location": string,
  "reporter_notified_at": datetime,
  "speche_warnings": string,
  "is_speche_assigned_transcript_id": boolean,
  "speche_return_code": string,
  "speche_request_at": datetime,
  "allow_speche_to_notify": boolean
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
scheduler_case_id
required

Scheduler Case ID

Validations:

  • Must be a Integer
starting_date
required

Start Date of first Event Schedule

Validations:

  • Must be a String


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

Start Time of first Event Schedule

Validations:

  • Must be a String


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

Deponent or Speaker

Validations:

  • Must be a String
internal_ref_num
optional

Internal Reference Number

Validations:

  • Must be a String
location
required

Validations:

  • Must be a String
is_video_streamed
optional

Enable video

Validations:

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

Enable realtime text

Validations:

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

Enable audio conferencing

Validations:

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

Validations:

  • Must be a String
reporter_name
optional

Validations:

  • Must be a String


Metadata: 
- required when is_text_streamed is true
text_account_num
optional

Reporter email address

Validations:

  • Must be a String


Metadata: 
- required when is_text_streamed is true
is_speche_assigned_transcript_id
optional

Have Speche assign this Transcript ID

Validations:

  • Must be one of: true, false.


Metadata: 
- required when is_text_streamed is true
time_zone
required

Validations:

  • Must be a String


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