Skip to content
RallyHere Docs
GitHub

Start Match

POST
/session/v1/session/{session_id}/match

Begin a new match for the current session, on the current instance

Required Permissions: For any player (including themselves)any of: session:update:any, session:*, session:update:self

Required Session Permissions: SessionPermissions.session_admin if user does not have the session:update:any auth permission

Authorizations

  • HTTPBearerHeadersOrCookie

Parameters

Path Parameters

session_id
required
string
>= 1 characters <= 128 characters

Request Body required

A request to create a match resource on a session

object
match_id
required

Unique ID

string
custom_data

Instance-defined custom data

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

Responses

200

Successful Response

The response to successfully creating a match on a session

object
match_id
required

Unique ID

string

403

Forbidden

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