Edit club room (dedicated server)

Edits a club room associated with a dedicated server.

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

Headers:


Path parameters:

  • {clubId} integer The ID of the club the room belongs to *
  • {activityId} integer The activity ID of the room to be edited *

Body parameters:

  • {name} string The new name of the room *
    Maximum: 20 characters
  • {login} string The new dedicated server username/login *
  • {folderId} integer The containing folder ID

The request body is an object with the room details to be edited:

{
  "name": name,
  "login": serverLogin,
  "folderId": folderId
}

Remarks:

  • This endpoint is only useful with tokens authenticated through Ubisoft user accounts (as opposed to dedicated server accounts).
  • Compared to regular club rooms, the response object will have less information available - specifically, maps and scriptSettings will likely be empty or contain old info about the server.
  • The same server login can be used multiple times - you will not receive an error response if the login is already in use.
  • The list of available server logins can be retrieved using the Get dedicated server accounts endpoint. This endpoint also indicates which logins are in use.
  • See the glossary for more information about folders.

Example request:

POST https://live-services.trackmania.nadeo.live/api/token/club/114118/room/1166614/edit-from-server
{
  "name": "Test Room",
  "login": "tmfast_7",
  "folderId": 0
}

Example response:

{
  "creationTimestamp": 1789164080,
  "clubName": "TMFAST",
  "id": 1166614,
  "activityId": 1166614,
  "campaignId": null,
  "name": "Test Room",
  "clubId": 114118,
  "roomId": null,
  "password": false,
  "room": {
    "id": null,
    "scalable": false,
    "serverInfo": null,
    "scriptSettings": [],
    "playerCount": 0,
    "serverAccountId": "cb46aa46-2022-4411-b497-6512015a0235",
    "name": "",
    "shufflePlaylist": false,
    "region": null,
    "maps": [],
    "script": "",
    "maxPlayers": 0
  },
  "mediaUrlPngSmall": "",
  "mediaUrl": "",
  "latestEditorAccountId": "3c1505cd-8a53-4e4e-817c-d808c277e64c",
  "nadeo": false,
  "mediaUrlPngLarge": "",
  "mediaTheme": "",
  "popularityLevel": 0,
  "creatorAccountId": "3c1505cd-8a53-4e4e-817c-d808c277e64c",
  "playerServerLogin": "tmfast_7",
  "mediaUrlDds": "",
  "mediaUrlPngMedium": ""
}

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 rooms, the response will contain an error:

[
  "clubMemberRole:error-notContentCreator"
]

If the login is invalid, the response will contain an error:

[
  "serverLogin:error-inArray"
]