Multiplayer Server - Update Build Name

Updates a multiplayer server build's name.

POST https://titleId.playfabapi.com/MultiplayerServer/UpdateBuildName

Request Header

Name Required Type Description
X-EntityToken True

string

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name Required Type Description
BuildId True

string

The guid string ID of the build we want to update the name of.

BuildName True

string

The build name.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name Type Description
200 OK

EmptyResponse

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response

EmptyResponse
UpdateBuildNameRequest

Updates a multiplayer server build's name.

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code

error

string

Playfab error code

errorCode

integer

Numerical PlayFab error code

errorDetails

object

Detailed description of individual issues with the request object

errorMessage

string

Description for the PlayFab errorCode

status

string

String HTTP code

EmptyResponse

UpdateBuildNameRequest

Updates a multiplayer server build's name.

Name Type Description
BuildId

string

The guid string ID of the build we want to update the name of.

BuildName

string

The build name.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Error Codes

Name Code
APINotEnabledForGameClientAccess 1082
MultiplayerServerBadRequest 1382
MultiplayerServerConflict 1386
MultiplayerServerForbidden 1384
MultiplayerServerInternalServerError 1387
MultiplayerServerNotFound 1385
MultiplayerServerUnauthorized 1383
MultiplayerServerUnavailable 1388