Skip to content
RallyHere Docs

Invite Session To Session

POST
/session/v1/session/{session_id}/invited-session/{invited_session_id}:invite

Invite an entire session to a target session

Required Permissions:

  • For any player (including themselves) any of: session:*, session:update-player:any

to invite any session regardless of membership status

Required Permissions:

  • For any player (including themselves) any of: session:*, session:update-player:any, session:update-player:self

to invite a session you are part of

Required Session Permissions: None

Authorizations

Parameters

Path Parameters

session_id
required
string
>= 1 characters <= 128 characters
invited_session_id
required
string
>= 1 characters <= 128 characters

Request Body required

object
team_id

Which team the players in the source session should be on

integer
overflow_action

How we should handle too many players being invited to the chosen team

string
Allowed values: fail allow_overflow partial_with_overflow partial_without_overflow overfill
custom_data

Custom data for all players being invited

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

Responses

200

Successful Response

Response to a request to update a session cohort

object
players
required

List of players that were updated

Array<object>

Response to a request to update a player in a session

object
player_uuid

Player UUID of the player updated

string format: uuid
status
required

Status of the player after the request is completed

string
Allowed values: leader member invited reserved
team_id
required

Which team the player joined

integer
custom_data

Resulting custom data about the player

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

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

Session doesn’t exist or Player is not a member of the session. See error code for more info

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

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