Documentation

DeleteTitle

Permanently deletes a title and all associated configuration

Request Details

Deletes all data associated with the title, including catalog, virtual currencies, leaderboard statistics, Cloud Script revisions, segment definitions, event rules, tasks, add-ons, secret keys, data encryption keys, and permission policies. Removes the title from its studio and removes all associated developer roles and permissions. Does not delete PlayStream event history associated with the title. Note, this API queues the title for deletion and returns immediately. It may take several hours or more before all title data is fully deleted. All player accounts in the title must be deleted before deleting the title. If any player accounts exist, the API will return a 'TitleContainsUserAccounts' error. Until the title data is fully deleted, attempts to call APIs with the title will fail with the 'TitleDeleted' error.

DeleteTitleRequest
Request Properties
POST https://{{TitleID}}.playfabapi.com/Admin/DeleteTitle
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{}
        

Response Details

DeleteTitleResult
Result Properties

Sample Response

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


Authentication

SecretKey

Possible Error Codes

Name Code
InvalidParams 1000
InvalidTitleId 1004
TitleContainsUserAccounts 1348
TitleDeleted 1347