Link Search Menu Expand Document

Prevail API: Schedule Sessions

Schedule Sessions (Self-Service)

POST https://prevail.ai/api/v1/session_requests

Creates a new scheduled Session. Your Organization must have Self-Service enabled to use this request to directly schedule Sessions. For Organizations without Self-Service, post a Session request.

For Zoom Meeting backend provider Sessions, all Session information is contained in the provider_specific_details response field object, including the meeting_id, password, prevail_join_url, and provider_join_url to access the Session.

Request Body Parameters

View Parameters
session_request object required
The details of the Session, including participant emails, Session information, and additional settings.
invite_emails array optional
A list of participant email addresses for the Session. For example: ["john@smith.com", "jane@doe.com"].
deponent object optional
Information about the deponent or witness participant, including their name, email, and role.
name string optional
The name of the deponent or witness participant. For example: John Smith.
email string optional
The email address of the deponent or witness participant. For example: john@smith.com.
role string optional
The role of the deponent or witness participant in the Session. Valid options are deponent and witness.
remote_session object required
Details about the remote Session, including the title, case identifier, and scheduled time.
title string required
case string required
The case identifier for the Session. For example: 123-case-id-name.
start_date string required
The date the Session is scheduled to start, formatted as YYYY-MM-DD. For example: 2025-01-28.
start_time string required
The time the Session is scheduled to start, formatted in 12-hour clock with AM/PM. For example: 01:30 AM.
time_zone string required
The time zone of the Session. Accepts valid time zones formatted with GMT offsets and region descriptions. The most commonly used values are: Eastern Time (US & Canada), Central Time (US & Canada), Mountain Time (US & Canada), Pacific Time (US & Canada), Alaska, Hawaii. For a comprehensive list of all time zones, refer to the IANA Time Zone Database.
session_details object optional
Additional details about the Session, including languages spoken or understood during the Session. For example: English, German.
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. Default value is English.
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.
additional_details string optional
Additional information or comments about the Session.
preferred_manager string optional
The name of the preferred manager for the Session.
video_provider string optional
The Session backend provider. Accepted values: chime, agora, zoom_meeting. Default value is chime.
session_type string optional
The Session type. Accepted values: remote_deposition, remote_call, webinar. Default value is remote_deposition.

Authorization

Bearer Token {{jwt_signed}}

Used to authenticate the request. Replace with your access token.

Headers

Content-Type application/json

Specifies the format of the request body.

Accept application/json

Specifies the format of the response body.

Example Request

{
    "session_request": {
        "invite_emails": ["john@smith.com", "jane@doe.com"],
        "deponent": {
            "name": "John Smith",
            "email": "john@smith.com",
            "role": "deponent"
        },
        "remote_session": {
            "title": "Example Remote Session",
            "case": "123-case-id-name",
            "start_date": "2025-01-28",
            "start_time": "01:30 AM",
            "time_zone": "Pacific Time (US & Canada)"
        },
        "session_details": {
            "additional_details": "",
            "preferred_manager": "Ashley Smith",
            "video_provider": "zoom_meeting",
            "session_type": "remote_deposition"
        }
    }
}
        
Example Response

{
    "requests": [
        {
            "id": 11760,
            "session_state": "scheduled",
            "session_url": "https://staging.prevail.ai/sessions/example-remote-session-id",
            "remote_session_id": "example-remote-session-id",
            "session_request": {
                "session_type": "remote_deposition",
                "deponent": {
                    "name": "John Smith",
                    "email": "john@smith.com",
                    "role": "deponent"
                },
                "invite_emails": [
                    "john@smith.com",
                    "jane@doe.com"
                ]
            },
            "remote_session": {
                "title": "Example Remote Session",
                "case": "123-case-id-name",
                "start_date": "2025-01-28",
                "start_time": "01:30 AM",
                "time_zone": "Pacific Time (US & Canada)"
            },
            "session_details": {
                "language": "en-US",
                "preferred_manager": "Ashley Smith",
                "video_provider": "zoom_meeting",
                "session_type": "remote_deposition"
            },
            "notice": null,
            "cancelation_requested": null,
            "provider_specific_details": {
                "meeting_id": 95317175962,
                "password": "awt4zzi7jv",
                "provider_join_url": "https://zoom.us/j/95317175962?pwd=E0Vmti19iYagOKzfZH08qJNKxlb5SG.1",
                "prevail_join_url": "https://staging.prevail.ai/sessions/example-remote-session/zoom_meeting"
            }
        }
    ]
}
        

Response Fields

View Response Fields
requests array
A list of Session requests, including details about each Session, its state, associated URLs, and other metadata.
id integer
A unique identifier for the Session. For example: 11749.
session_state string
The current state of the Session is scheduled for Self-Service Sessions.
session_url string
The URL to access the Session. For example: https://staging.prevail.ai/sessions/example-remote-session.
remote_session_id string
A unique identifier for the remote Session. For example: example-remote-session-id. Use this identifier to cancel or edit the Session.
provider_specific_details object
The joining details specific to the selected video_provider when a provider other than the default chime is used. It includes the meeting ID, password, and URLs for participants to join the Session. The prevail_join_url is provided for users who wish to join the Session from Prevail instead of the video provider's platform.
meeting_id integer
The unique meeting ID for the Session, specific to the selected video_provider. For example: 92583913564.
password string
The password required to join the meeting through the selected video_provider. For example: 4c5siwtlvu.
provider_join_url string
The URL for participants to join the meeting directly through the selected video_provider. For example: https://zoom.us/j/92583913564?pwd=WJbdajUm3NnDjNDbDvkgMagY61FWfy.1.
prevail_join_url string
The URL for participants to join the meeting through the Prevail Sessions application, instead of the selected video_provider. For example: https://prevail.ai/sessions/example-remote-session/zoom_meeting.
Provider Specific Details for Zoom Backend Provider Sessions
Response Field Description
meeting_id The unique Zoom Meeting ID for the Session.
password The Zoom Meeting password required to join the meeting from the provider_join_url.
prevail_join_url The URL to join from the Prevail Sessions application.
provider_join_url The URL to join from the Zoom desktop or mobile application.

Copyright ©2025 Prevail Legal

Last modified: January 24, 2025