Create club ranking

POST https://live-services.trackmania.nadeo.live/api/token/club/{clubId}/ranking/create

Headers:


Path parameters:

  • {clubId} integer The ID of the club where the ranking should be created *

Body parameters:

  • {name} string The name of the new ranking *
    Maximum: 20 characters
  • {name} string The use case of the ranking (see remarks below) *
  • {campaignId} integer The campaign ID of a campaign from the club (see remarks below)
  • {folderId} integer The ID of the folder where the ranking should be created

The request body is an object containing the ranking details:

{
  "name": name,
  "useCase": useCase,
  "campaignId": campaignId,
  "folderId": folderId
}

Creates a ranking in a club.


Remarks:

  • This endpoint is only useful with tokens authenticated through Ubisoft user accounts (as opposed to dedicated server accounts).
  • The useCase parameter supports three cases: Current Quarterly Campaign ("ranking-official"), Daily Track / TOTD ("ranking-daily"), and Club Campaign ("ranking-club").
  • When creating a Club Campaign ranking, it is required to set the campaignId parameter to the campaign ID of a campaign from the club.
  • If the club campaign is not a campaign from the club, or it does not exist, the ranking will be created, but an error will be displayed in-game when accessing the ranking.
  • See the glossary for more information about folders.

Example request:

POST https://live-services.trackmania.nadeo.live/api/token/club/103034/ranking/create
{
  "name": "Winter ranks",
  "useCase": "ranking-club",
  "campaignId": 127610,
  "folderId": 0
}

Example response:

{
  "creationTimestamp": 1771993468,
  "clubName": "Fort's club",
  "id": 1007578,
  "campaignId": 127610,
  "name": "Winter ranks",
  "clubId": 103034,
  "latestEditorAccountId": "69f31664-4252-48e0-a433-024c49caee8c",
  "creatorAccountId": "69f31664-4252-48e0-a433-024c49caee8c",
  "useCase": "ranking-club"
}

If the club does not exist or the authenticated account is not a member of the club, the response will contain an error:

[
  "clubMemberRole:error-notMember"
]

If the authenticated account does not have enough permissions in the club to create rankings, the response will contain an error:

[
  "clubMemberRole:error-notContentCreator"
]

If the useCase parameter is invalid, the response will contain an error:

[
  "useCase:error-inArray"
]