Documentation

AbortTaskInstance

Abort an ongoing task instance.

Request Details

If the task instance has already completed, there will be no-op.

AbortTaskInstanceRequest
Request Properties
TaskInstanceId (required) String

ID of a task instance that is being aborted.

POST https://{{TitleID}}.playfabapi.com/Admin/AbortTaskInstance
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "TaskInstanceId": "E52531B47B1761C7-4"
}
        

Response Details

EmptyResponse
Result Properties

Sample Response

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


Authentication

SecretKey

Possible Error Codes

Name Code
TaskInstanceNotFound 1262