changeStateRace

Deprecated

PUT

/races/{url}/change_state.json

Changes a race's state

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

OAuth 2.0

Authorization Code

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://api.challonge.com/oauth/authorize

Token URL: https://api.challonge.com/oauth/token

Path Params

Header Params

Body Params application/vnd.api+jsonRequired

Examples

Responses

🟢200OK

application/json

Race Response

Body

🟠401Unauthorized

🟠404Not Found

🟠406Not Acceptable

🟠415Unsupported Media Type

🟠422Unprocessable Entity

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.challonge.com/v2/races//change_state.json' \
--header 'Accept;' \
--header 'Authorization-Type;' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "type": "RaceState",
        "attributes": {
            "state": "start"
        }
    }
}'

Response Example

200 - Example 1

{
    "data": {
        "id": "horse_racing_101",
        "type": "Race",
        "attributes": {
            "name": "Horse Racing 101",
            "url": "horse_racing_101",
            "raceType": "time trial",
            "description": "string",
            "private": true,
            "currentLap": {
                "id": 15,
                "number": 1
            },
            "notifications": {
                "uponMatchesOpen": true,
                "uponTournamentEnds": true
            },
            "registrationOptions": {
                "openSignup": false,
                "signupCap": 0
            },
            "grandPrixOptions": {
                "rounds": 4
            },
            "timestamps": {
                "startsAt": "string",
                "createdAt": "string",
                "updatedAt": "string",
                "completedAt": "string"
            }
        },
        "relationships": {
            "rounds": {
                "links": {
                    "related": "https://api.challonge.com/<endpoint>/<url>/<relationship>/<relationship_id>.json",
                    "meta": {
                        "count": 0
                    }
                }
            },
            "participants": {
                "links": {
                    "related": "https://api.challonge.com/<endpoint>/<url>/<relationship>/<relationship_id>.json",
                    "meta": {
                        "count": 0
                    }
                }
            }
        },
        "links": {
            "self": "https://api.challonge.com/races/<url>.json"
        }
    }
}

Modified at 2025-11-05 16:05:35

deleteRace

findRounds