Sign in
Sessions

Create a session

Creates a new short-lived session that you can pass to the Scheduling Component to enforce user authentication. Your request must include the ID of an existing Configuration object.

post/v3/scheduling/sessions

Request body

configuration_idstring

The ID of the Scheduler Configuration object for the session. If you're using slug, configuration_id is not required.

slugstring

The slug of the Scheduler Configuration object for the session. You can use slug instead of configuration_id.

time_to_livenumber

The time to live for the session in minutes. The maximum value is 30.

Example request

{
  "configuration_id": "AAAA-BBBB-1111-2222",
  "slug": "my-page-slug",
  "time_to_live": 10
}

Response

Create a new scheduling session

request_idstring

The request ID.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.