Edit a leaderboard
Modify the details of a leaderboard.
URL
PATCH https://api.appstoreconnect.apple.com/v1/gameCenterLeaderboards/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | An opaque resource ID that uniquely identifies the resource. Obtain the leaderboard resource ID from the Read leaderboard information response. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | GameCenterLeaderboardResponse | |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | |
| 404 | Not Found Content-Type: application/json | ErrorResponse | |
| 409 | Conflict Content-Type: application/json | ErrorResponse | |
| 422 | Content-Type: application/json | ErrorResponse | |
| 429 | Content-Type: application/json | ErrorResponse |
Discussion
Use leaderboard formatters to specify the unit of measurement for a Game Center leaderboard. There is a new required attribute defaultFormatter when you use Create a leaderboard, which gives all your localizations the same formatter. You can also optionally use formatterOverride to override a specific leaderboard localization when calling Create a leaderboard localization or Modify a leaderboard localization.
Before App Store Connect API version 3.0, formatters were based on localizations and were required for each localization. Legacy leaderboards created before the new addition of the Game Center APIs will not have a defaultFormatter value, the value would be null in this case. Any localizations created before the new addition of the Game Center APIs will always have a formatterOverride.
HTTP Body
See Also
Creating, modifying, and deleting leaderboards
Create a Game Center leaderboardModify a Game Center leaderboardModify the activity for a Game Center leaderboardModify the challenge for a Game Center leaderboardDelete a Game Center leaderboardCreate a leaderboardEdit the relationship between a leaderboard and a group leaderboardPATCH /v1/gameCenterLeaderboards/{id}/relationships/activityPATCH /v1/gameCenterLeaderboards/{id}/relationships/challengeDelete a leaderboard