Documentation

AbortFileUploads

Abort pending file uploads to an entity's profile.

Request Details

Aborts the pending upload of the requested files.

AbortFileUploadsRequest
Request Properties
Entity (required) EntityKey

The entity to perform this action on.

FileNames (required) List<String>

Names of the files to have their pending uploads aborted.

ProfileVersion int32

The expected version of the profile, if set and doesn't match the current version of the profile the operation will not be performed.

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

Response Details

AbortFileUploadsResponse
Result Properties
Entity EntityKey

The entity id and type.

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
{
  "code": 200,
  "status": "OK",
  "data": {
    "ProfileVersion": 8,
    "Entity": {
      "Id": "ID",
      "Type": "title_player_account",
      "TypeString": "title_player_account"
    }
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
FileNotFound 1045
NoEntityFileOperationPending 1351