Update Match Segment

PUT

/match/v1/match/{match_id}/segment/{segment_id}

Update match segment by match_id and segment_id.

Match must be in pending state to be updated.

Required Permissions:

• For any match segment any of: match:*, match:match:edit:any

• For match segment if the player is the host any of: match:*, match:match:edit:any, match:match:edit:authority

Authorizations

• HTTPBearerHeadersOrCookie

Parameters

Path Parameters

match_id

required

string

segment_id

required

string

Request Body ^required

object

match_segment

required

Segment ID of the match

string

>= 1 characters <= 16 characters

type

Any of:

string

string

null

null

state

Any of:

MatchState

Match States.

string

Allowed values: pending closed

null

null

start_timestamp

Any of:

Time Zone Aware Datetime

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

2023-01-23T21:07:02.000000+00:00

null

null

end_timestamp

Any of:

Time Zone Aware Datetime

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

2023-01-23T21:07:02.000000+00:00

null

null

duration_seconds

Any of:

integer

integer

null

null

custom_data

Any of:

object

object

key

additional properties

string

null

null

correlation_id

Any of:

string

string

null

null

sessions

List of session IDs for the match

Array<object>

default:

object

session_id

required

Session ID

string

matchmaking_profile_id

Any of:

string

string

null

null

instances

List of MatchInstances for the match

Array<object>

default:

object

instance_id

Any of:

string

string

null

null

host_player_uuid

Any of:

string

string format: uuid

null

null

region_id

Any of:

string

string

null

null

instance_request_template_id

Any of:

string

string

null

null

map

Any of:

string

string

null

null

game_mode

Any of:

string

string

null

null

host_type

Any of:

HostType

Whether the host is another player, or a dedicated instance

string

Allowed values: dedicated player

null

null

allocations

List of allocation IDs for the match

Array<object>

default:

object

allocation_id

required

Allocation ID

string

players

List of players in the match

Array<object>

default:

object

player_uuid

string format: uuid

team_id

Any of:

string

string

null

null

party_session_id

Any of:

string

string

null

null

placement

Any of:

integer

integer

null

null

joined_match_timestamp

Any of:

Time Zone Aware Datetime

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

2023-01-23T21:07:02.000000+00:00

null

null

left_match_timestamp

Any of:

Time Zone Aware Datetime

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

2023-01-23T21:07:02.000000+00:00

null

null

duration_seconds

Any of:

integer

integer

null

null

starting_rank

Any of:

string

string

null

null

finishing_rank

Any of:

string

string

null

null

custom_data

Any of:

object

object

key

additional properties

string

null

null

Responses

200

Successful Response

object

last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time

2023-01-23T21:07:02.000000+00:00

created_timestamp

Timestamp of when the resource was created

string format: date-time

2023-01-23T21:07:02.000000+00:00

type

Any of:

string

string

null

null

state

Any of:

MatchState

Match States.

string

Allowed values: pending closed

null

null

start_timestamp

Any of:

Time Zone Aware Datetime

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

2023-01-23T21:07:02.000000+00:00

null

null

end_timestamp

Any of:

Time Zone Aware Datetime

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

2023-01-23T21:07:02.000000+00:00

null

null

duration_seconds

Any of:

integer

integer

null

null

custom_data

Any of:

object

object

key

additional properties

string

null

null

correlation_id

Any of:

string

string

null

null

sessions

List of session IDs for the match

Array<object>

default:

object

session_id

required

Session ID

string

matchmaking_profile_id

Any of:

string

string

null

null

instances

List of MatchInstances for the match

Array<object>

default:

object

instance_id

Any of:

string

string

null

null

host_player_uuid

Any of:

string

string format: uuid

null

null

region_id

Any of:

string

string

null

null

instance_request_template_id

Any of:

string

string

null

null

map

Any of:

string

string

null

null

game_mode

Any of:

string

string

null

null

host_type

Any of:

HostType

Whether the host is another player, or a dedicated instance

string

Allowed values: dedicated player

null

null

allocations

List of allocation IDs for the match

Array<object>

default:

object

allocation_id

required

Allocation ID

string

match_segment

required

Segment ID of the match

string

>= 1 characters <= 16 characters

match_id

string

players

List of players in the match

Array<object>

default:

object

last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time

2023-01-23T21:07:02.000000+00:00

created_timestamp

Timestamp of when the resource was created

string format: date-time

2023-01-23T21:07:02.000000+00:00

player_uuid

string format: uuid

team_id

Any of:

string

string

null

null

party_session_id

Any of:

string

string

null

null

placement

Any of:

integer

integer

null

null

joined_match_timestamp

Any of:

Time Zone Aware Datetime

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

2023-01-23T21:07:02.000000+00:00

null

null

left_match_timestamp

Any of:

Time Zone Aware Datetime

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time

2023-01-23T21:07:02.000000+00:00

null

null

duration_seconds

Any of:

integer

integer

null

null

starting_rank

Any of:

string

string

null

null

finishing_rank

Any of:

string

string

null

null

custom_data

Any of:

object

object

key

additional properties

string

null

null

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token
• auth_invalid_version - Invalid Authorization - version
• auth_malformed_access - Invalid Authorization - malformed access token
• auth_not_jwt - Invalid Authorization
• auth_token_expired - Token is expired
• auth_token_format - Invalid Authorization - {}
• auth_token_invalid_claim - Token contained invalid claim value: {}
• auth_token_invalid_type - Invalid Authorization - Invalid Token Type
• auth_token_sig_invalid - Token Signature is invalid
• auth_token_unknown - Failed to parse token
• insufficient_permissions - Insufficient Permissions

object

auth_success

boolean

default: true

error_code

required

string

desc

required

string

404

Not Found

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