Skip to content
The Aggregator

Cancel a free-round grant

POST
/free-rounds/{grant_id}/cancel

Cancel a grant’s outstanding (unplayed) rounds. Already-played rounds are not reversed. Requires the write scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
grant_id
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
sub_operator_ref
string
brand-01

Platform accounts only. Which brand this call acts as — the same ref the session or grant was created with. Same format and error codes as sub_operator_ref on POST /v1/sessions: omit it to use your default brand, and note that sending it empty is a 400 (E6004), not a fallback.

Responses

Section titled “Responses”

200

Section titled “200”

Grant cancelled.

object
grant_id
string format: uuid
status
string
Allowed values: cancelled cancel_failed
games
Array<object>
object
game_id
string format: uuid
status
string
error
string
nullable

401

Section titled “401”

Missing, invalid, or revoked API key.

object
error
required
object
code
required

Machine-parseable error code. See https://docs.aggregator.gg/resources/error-codes/.

string
/^E[0-9A-F][0-9]{3}$/
E0001
type

Snake-case mnemonic for the code (e.g. game_blocked_jurisdiction, player_self_excluded). Branch on code; type is for readability.

string
game_blocked_jurisdiction
message
required
string
request_id

Correlation ID for support escalation.

string
details
object
key
additional properties
any

404

Section titled “404”

Grant not found.

object
error
required
object
code
required

Machine-parseable error code. See https://docs.aggregator.gg/resources/error-codes/.

string
/^E[0-9A-F][0-9]{3}$/
E0001
type

Snake-case mnemonic for the code (e.g. game_blocked_jurisdiction, player_self_excluded). Branch on code; type is for readability.

string
game_blocked_jurisdiction
message
required
string
request_id

Correlation ID for support escalation.

string
details
object
key
additional properties
any

409

Section titled “409”

Grant is in a terminal state and cannot be cancelled.

object
error
required
object
code
required

Machine-parseable error code. See https://docs.aggregator.gg/resources/error-codes/.

string
/^E[0-9A-F][0-9]{3}$/
E0001
type

Snake-case mnemonic for the code (e.g. game_blocked_jurisdiction, player_self_excluded). Branch on code; type is for readability.

string
game_blocked_jurisdiction
message
required
string
request_id

Correlation ID for support escalation.

string
details
object
key
additional properties
any