Skip to content
RallyHere Docs

Create Platform Session Template

POST
/v1/sandbox/{sandbox_id}/session-template/{session_template_id}/platform-session-template

Add a new Platform Session Template for a specific Session Template

Requires permission sandbox:config:edit.

Authorizations

Parameters

Path Parameters

session_template_id
required
string format: uuid
sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Request Body required

object
platform_session_type
required

The platform’s name for this type of platform session

string
>= 1 characters <= 50 characters
max_players

The maximum number of players that are allowed within this platform session

integer
>= 1
custom_data

Custom passthrough data that will be added to all sessions of this type

object
key
additional properties
string
>= 1 characters <= 4096 characters
platform
required

Which platform this template is associated with

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch RallyHere LegacyName

Responses

201

Successful Response

object
platform_session_type
required

The platform’s name for this type of platform session

string
>= 1 characters <= 50 characters
max_players

The maximum number of players that are allowed within this platform session

integer
>= 1
custom_data

Custom passthrough data that will be added to all sessions of this type

object
key
additional properties
string
>= 1 characters <= 4096 characters
platform
required

Which platform this template is associated with

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch RallyHere LegacyName
sandbox_id

ID of the Sandbox

string format: uuid
session_template_id
required

Unique id for this type of session that this template is associated with

string format: uuid
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string