Documentation

UpdateTask

Update an existing task.

Request Details

Note that when calling this API, all properties of the task have to be provided, including properties that you do not want to change. Parameters not specified would be set to default value. If the task name in the update request is new, a task rename operation will be executed before updating other fields of the task. WARNING: Renaming of a task may break logics where the task name is used as an identifier.

UpdateTaskRequest
Request Properties
Description String

Description the task

Identifier NameIdentifier

Specify either the task ID or the name of the task to be updated.

IsActive (required) Boolean

Whether the schedule is active. Inactive schedule will not trigger task execution.

Name (required) String

Name of the task. This is a unique identifier for tasks in the title.

Parameter object

Parameter object specific to the task type. See each task type's create API documentation for details.

Schedule String

Cron expression for the run schedule of the task. The expression should be in UTC.

Type (required) ScheduledTaskType

Task type.

POST https://{{TitleID}}.playfabapi.com/Admin/UpdateTask
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "Identifier": {
    "Name": "PushEventNotificationVIP_Halloween"
  },
  "Name": "PushEventNotificationVIP_Thanksgiving",
  "Description": "Send push notification to VIP about Thanksgiving event",
  "IsActive": false,
  "Type": "ActionsOnPlayerSegment",
  "Parameter": {
    "SegmentId": "E2B0F9C19B02D796",
    "ActionId": "DEC740F924D304C6"
  }
}
        

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
InvalidScheduledTaskName 1256
InvalidScheduledTaskParameter 1391
InvalidScheduledTaskType 1265
InvalidTaskSchedule 1257
ScheduledTaskCreateConflict 1255
ScheduledTaskNameConflict 1254
TaskNotFound 1261