Link Search Menu Expand Document

Request and Response Fields

Request Fields

Field Parameter Path Type Required
session_request session_request object required
The top-level request object that contains the Session setup information, including participants, scheduling, and configuration settings.
invites session_request.invites array optional
A list of participant email addresses for the Session, including participants and Hosts. Participants added to the list receive Session notification emails automatically. Once participants are invited, they cannot be removed from the Session. To remove participants, cancel the Session using the PATCH Cancel Session API request and schedule a new Session. If omitted, defaults to "access_level": "participant".
email session_request.invites.email string required
The email address of the Session participant.
access_level session_request.invites.access_level string optional
The role assigned to the Session participant associated with the email. If omitted, defaults to "access_level": "participant".
host session_request.invites.access_level.host string optional
A Session participant with Host permissions who manages the Session. To designate a Host, include the key-value pair "access_level": "host". A Host’s "email" must be associated with a registered Prevail Member’s account. If a Host’s "email" is not associated with a registered account, the API ignores the value "host" and assigns "access_level": "participant". Session Hosts do not receive Session notification emails by default. To enable Session notification emails for Hosts, also include their email address in the invites array without assigning the access_level key. Example: { "email": "azurite@example.com", "access_level": "host" }
deponent session_request.deponent object optional
Information about the deponent or witness participant, including their name, email, and role.
name session_request.deponent.name string optional
The name of the deponent or witness participant. For example: Malachite Yarrow.
email session_request.deponent.email string optional
The email address of the deponent or witness participant. For example: malachite@example.com.
role session_request.deponent.role string optional
The role assigned to the deponent or witness participant in the Session. Accepted values: deponent and witness.
remote_session session_request.remote_session object required
Details about the Session, including the title, case identifier, and scheduled time.
title session_request.remote_session.title string required
The Session title. The API automatically converts the title into the Session URL slug, converting capital letters to lowercase and spaces to hyphens. For example, "This Is The Title" is converted to this-is-the-title.
remote_session_id session_request.remote_session.remote_session_id string optional
The custom unique identifier for the Session URL.
case session_request.remote_session.case string required
The case identifier for the Session. For example: 123-case-id-name.
start_date session_request.remote_session.start_date string required
The date the Session is scheduled to start, formatted as YYYY-MM-DD. For example: 2025-01-28.
start_time session_request.remote_session.start_time string required
The time the Session is scheduled to start, formatted in 12-hour clock as hh:mm AM/PM. For example: 01:30 AM.
time_zone session_request.remote_session.time_zone string required
The time zone of the Session. Accepts named values such as Eastern Time (US & Canada), Central Time (US & Canada), etc. For a full list of valid time zones, refer to the IANA Time Zone Database.
estimated_duration session_request.remote_session.estimated_duration number optional
The estimated duration of the Session in hours. Accepts decimal values. For example: 2.5 for 2 hours and 30 minutes. If omitted, defaults to 4.0.
session_details session_request.session_details object optional
Configuration options for the Session, such as preferred language, manager name, video provider, and optional Session type.
interpreter session_request.session_details.interpreter string optional
The language interpreter required for the Session. Supported values include: Afrikaans, Arabic, Gulf, Arabic, Modern Standard, Chinese, Mandarin (Mainland China), Chinese, Mandarin (Taiwan), Danish, Dutch, English, Australian, English, British, English, Indian, English, Irish, English, New Zealand, English, Scottish, English, South African, English, US, English, Welsh, French, French, Canadian, Farsi, German, German, Swiss, Hebrew, Hindi, Indian, Indonesian, Italian, Japanese, Korean, Malay, Portuguese, Portuguese, Brazilian, Russian, Spanish, Spanish, US, Tamil, Telugu, Thai, Turkish, Other.
languages session_request.session_details.languages array optional
A list of languages spoken or understood during the Session. Include English and one or more languages from the interpreter parameter if the Session requires a language interpreter. If omitted, the default value is English.
additional_details session_request.session_details.additional_details string optional
Additional instructions or comments for the Prevail Scheduling Team about the Session request.
preferred_manager session_request.session_details.preferred_manager string optional
The name of the preferred Host for the Session. For example: "Quartz Verbena".
video_provider session_request.session_details.video_provider string optional
The Session backend provider. Provides third-party audio-video technology and video-streaming hosting and does not affect the general appearance or function of the Sessions Application. Accepted values: chime, agora, zoom_meeting. If omitted, defaults to chime.
session_type session_request.session_details.session_type string optional
The Session type. Accepted values: remote_deposition, remote_call, webinar. If omitted, defaults to remote_deposition.
postback_url session_request.postback_url string optional
The URL that receives Session details after creation. If omitted, Session details must be retrieved manually using the GET /session_requests endpoint. For example: https://example.com/webhook.

Response Fields

Field Parameter Path Type
requests requests array
A list of Session requests, including details about each Session, its state, associated URLs, and other metadata.
id requests[].id integer
A unique identifier for the Session. For example: 11749.
session_state requests[].session_state string
The current state of the Session is scheduled for Self-Service Sessions.
session_url requests[].session_url string
The URL to access the Session. For example: https://staging.prevail.ai/sessions/example-remote-session.
remote_session_id requests[].remote_session_id string
A unique identifier for the Session. For example: example-remote-session-id. Use this identifier to cancel or edit the Session.
session_request requests[].session_request object
The original request body submitted to create the Session, including deponent information, invites, and optional Session configuration.
remote_session requests[].remote_session object
Details about the Session, including title, date, time, and estimated duration.
session_details requests[].session_details object
The confirmed configuration object for the Session, including language, preferred manager, and backend video provider. Values in this object may be defaulted or updated based on staff review.
notice requests[].notice string or null
Internal staff message or system-generated note associated with the Session request.
cancellation_requested requests[].cancellation_requested boolean or null
Indicates whether cancellation has been requested for the Session. Returns `true` if cancellation was requested for the Session; otherwise returns `null`.
provider_specific_details requests[].provider_specific_details object
The joining details specific to the selected video_provider, used when a provider other than chime is specified. Includes the meeting ID, password, and join URLs.
meeting_id requests[].provider_specific_details.meeting_id integer
The unique meeting ID for the Session, specific to the selected video_provider. Example: 92583913564.
password requests[].provider_specific_details.password string
The password required to join the meeting through the selected video_provider. Example: 4c5siwtlvu.
provider_join_url requests[].provider_specific_details.provider_join_url string
The URL for participants to join the meeting directly through the selected video_provider. Example: https://zoom.us/j/92583913564?...etc.
prevail_join_url requests[].provider_specific_details.prevail_join_url string
The URL for participants to join the meeting through the Prevail Sessions app instead of the selected video_provider. Example: https://prevail.ai/sessions/example-remote-session/zoom_meeting.

Session States

Field Value Description
session_state initial Session Request is created and awaiting review by the Prevail Scheduling Team. The session_url and remote_session_id are null.
session_state scheduled Session is scheduled. Applies to Organizations that submit Session requests. The Session join URL and remote_session_id are assigned.
session_state ready Session is scheduled. Applies to self-service Organizations. The Session join URL and remote_session_id are assigned.
session_state active Session is in progress. Participants can join using the Session join URL.
session_state canceled Session was canceled. The Session join URL is disabled and participants can no longer join.
Copyright ©2025 Prevail Legal

Last modified: May 22, 2025