Documentation

FinalizeFileUploads

Finalize file uploads to an entity's profile.

Request Details

Finalizes the upload of the requested files. Verifies that the files have been successfully uploaded and moves the file pointers from pending to live.

FinalizeFileUploadsRequest
Request Properties
Entity (required) EntityKey

The entity to perform this action on.

FileNames (required) List<String>

Names of the files to be finalized. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'

POST https://{{TitleID}}.playfabapi.com/File/FinalizeFileUploads
    Content-Type: application/json
{
  "FileNames": [
    "profile_configuration",
    "game_state"
  ],
  "Entity": {
    "Id": "ID",
    "Type": "title_player_account",
    "TypeString": "title_player_account"
  }
}
        

Response Details

FinalizeFileUploadsResponse
Result Properties
Entity EntityKey

The entity id and type.

Metadata Dict<String, GetFileMetadata>

Collection of metadata for the entity's files

ProfileVersion (required) int32

The current version of the profile, can be used for concurrency control during updates.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

EntityToken

Possible Error Codes

Name Code
FileNotFound 1045
NoEntityFileOperationPending 1351