Update Task

Update an existing task.

Error codes

This operation may return the following PlayFab errors:

Error	Code
CloudScriptAzureFunctionsArgumentSizeExceeded	1471
InvalidJSONContent	1200
InvalidParams	1000
InvalidScheduledTaskName	1256
InvalidScheduledTaskParameter	1391
InvalidScheduledTaskType	1265
InvalidTaskSchedule	1257
InvalidVirtualCurrencyCode	1236
OverLimit	1214
PushNotEnabledForAccount	1094
PushNotificationTemplateInvalidSyntax	1419
PushNotificationTemplateNotFound	1417
ScheduledTaskCreateConflict	1255
ScheduledTaskNameConflict	1254
StatisticNotFound	1195
TaskNotFound	1261

POST

Admin

UpdateTask

Update Task

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/UpdateTask \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "Identifier": {
    "Name": "PushEventNotificationVIP_Halloween"
  },
  "Name": "PushEventNotificationVIP_Thanksgiving",
  "Description": "Send push notification to VIP about Thanksgiving event",
  "Type": "ActionsOnPlayerSegment",
  "Parameter": {
    "SegmentId": "E2B0F9C19B02D796",
    "Actions": [
      {
        "GrantItemContent": {
          "CatalogVersion": "foo",
          "ItemId": "bar",
          "ItemQuantity": 1
        }
      }
    ]
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/UpdateTask"

payload = {
    "Identifier": { "Name": "PushEventNotificationVIP_Halloween" },
    "Name": "PushEventNotificationVIP_Thanksgiving",
    "Description": "Send push notification to VIP about Thanksgiving event",
    "Type": "ActionsOnPlayerSegment",
    "Parameter": {
        "SegmentId": "E2B0F9C19B02D796",
        "Actions": [{ "GrantItemContent": {
                    "CatalogVersion": "foo",
                    "ItemId": "bar",
                    "ItemQuantity": 1
                } }]
    }
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Identifier: {Name: 'PushEventNotificationVIP_Halloween'},
    Name: 'PushEventNotificationVIP_Thanksgiving',
    Description: 'Send push notification to VIP about Thanksgiving event',
    Type: 'ActionsOnPlayerSegment',
    Parameter: {
      SegmentId: 'E2B0F9C19B02D796',
      Actions: [{GrantItemContent: {CatalogVersion: 'foo', ItemId: 'bar', ItemQuantity: 1}}]
    }
  })
};

fetch('https://{titleId}.playfabapi.com/Admin/UpdateTask', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/UpdateTask",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Identifier' => [
        'Name' => 'PushEventNotificationVIP_Halloween'
    ],
    'Name' => 'PushEventNotificationVIP_Thanksgiving',
    'Description' => 'Send push notification to VIP about Thanksgiving event',
    'Type' => 'ActionsOnPlayerSegment',
    'Parameter' => [
        'SegmentId' => 'E2B0F9C19B02D796',
        'Actions' => [
                [
                                'GrantItemContent' => [
                                                                'CatalogVersion' => 'foo',
                                                                'ItemId' => 'bar',
                                                                'ItemQuantity' => 1
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/UpdateTask"

	payload := strings.NewReader("{\n  \"Identifier\": {\n    \"Name\": \"PushEventNotificationVIP_Halloween\"\n  },\n  \"Name\": \"PushEventNotificationVIP_Thanksgiving\",\n  \"Description\": \"Send push notification to VIP about Thanksgiving event\",\n  \"Type\": \"ActionsOnPlayerSegment\",\n  \"Parameter\": {\n    \"SegmentId\": \"E2B0F9C19B02D796\",\n    \"Actions\": [\n      {\n        \"GrantItemContent\": {\n          \"CatalogVersion\": \"foo\",\n          \"ItemId\": \"bar\",\n          \"ItemQuantity\": 1\n        }\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/UpdateTask")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Identifier\": {\n    \"Name\": \"PushEventNotificationVIP_Halloween\"\n  },\n  \"Name\": \"PushEventNotificationVIP_Thanksgiving\",\n  \"Description\": \"Send push notification to VIP about Thanksgiving event\",\n  \"Type\": \"ActionsOnPlayerSegment\",\n  \"Parameter\": {\n    \"SegmentId\": \"E2B0F9C19B02D796\",\n    \"Actions\": [\n      {\n        \"GrantItemContent\": {\n          \"CatalogVersion\": \"foo\",\n          \"ItemId\": \"bar\",\n          \"ItemQuantity\": 1\n        }\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/UpdateTask")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Identifier\": {\n    \"Name\": \"PushEventNotificationVIP_Halloween\"\n  },\n  \"Name\": \"PushEventNotificationVIP_Thanksgiving\",\n  \"Description\": \"Send push notification to VIP about Thanksgiving event\",\n  \"Type\": \"ActionsOnPlayerSegment\",\n  \"Parameter\": {\n    \"SegmentId\": \"E2B0F9C19B02D796\",\n    \"Actions\": [\n      {\n        \"GrantItemContent\": {\n          \"CatalogVersion\": \"foo\",\n          \"ItemId\": \"bar\",\n          \"ItemQuantity\": 1\n        }\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Authorizations

X-SecretKey

string

header

required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json

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.

IsActive

boolean

required

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

Name

string

required

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

Type

enum<string>

required

Task type.

Available options:

CloudScript,

ActionsOnPlayerSegment,

CloudScriptAzureFunctions,

InsightsScheduledScaling

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Description

string

Description the task

Identifier

object

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

Show child attributes

Example:

{
  "Name": "MyTask",
  "Id": "d739e188-22f6-4d13-a4d5-df2e93d4d2f7"
}

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.

Response

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Last modified on October 2, 2026

⌘I

Update Task

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/UpdateTask \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "Identifier": {
    "Name": "PushEventNotificationVIP_Halloween"
  },
  "Name": "PushEventNotificationVIP_Thanksgiving",
  "Description": "Send push notification to VIP about Thanksgiving event",
  "Type": "ActionsOnPlayerSegment",
  "Parameter": {
    "SegmentId": "E2B0F9C19B02D796",
    "Actions": [
      {
        "GrantItemContent": {
          "CatalogVersion": "foo",
          "ItemId": "bar",
          "ItemQuantity": 1
        }
      }
    ]
  }
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/UpdateTask"

payload = {
    "Identifier": { "Name": "PushEventNotificationVIP_Halloween" },
    "Name": "PushEventNotificationVIP_Thanksgiving",
    "Description": "Send push notification to VIP about Thanksgiving event",
    "Type": "ActionsOnPlayerSegment",
    "Parameter": {
        "SegmentId": "E2B0F9C19B02D796",
        "Actions": [{ "GrantItemContent": {
                    "CatalogVersion": "foo",
                    "ItemId": "bar",
                    "ItemQuantity": 1
                } }]
    }
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Identifier: {Name: 'PushEventNotificationVIP_Halloween'},
    Name: 'PushEventNotificationVIP_Thanksgiving',
    Description: 'Send push notification to VIP about Thanksgiving event',
    Type: 'ActionsOnPlayerSegment',
    Parameter: {
      SegmentId: 'E2B0F9C19B02D796',
      Actions: [{GrantItemContent: {CatalogVersion: 'foo', ItemId: 'bar', ItemQuantity: 1}}]
    }
  })
};

fetch('https://{titleId}.playfabapi.com/Admin/UpdateTask', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/UpdateTask",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Identifier' => [
        'Name' => 'PushEventNotificationVIP_Halloween'
    ],
    'Name' => 'PushEventNotificationVIP_Thanksgiving',
    'Description' => 'Send push notification to VIP about Thanksgiving event',
    'Type' => 'ActionsOnPlayerSegment',
    'Parameter' => [
        'SegmentId' => 'E2B0F9C19B02D796',
        'Actions' => [
                [
                                'GrantItemContent' => [
                                                                'CatalogVersion' => 'foo',
                                                                'ItemId' => 'bar',
                                                                'ItemQuantity' => 1
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/UpdateTask"

	payload := strings.NewReader("{\n  \"Identifier\": {\n    \"Name\": \"PushEventNotificationVIP_Halloween\"\n  },\n  \"Name\": \"PushEventNotificationVIP_Thanksgiving\",\n  \"Description\": \"Send push notification to VIP about Thanksgiving event\",\n  \"Type\": \"ActionsOnPlayerSegment\",\n  \"Parameter\": {\n    \"SegmentId\": \"E2B0F9C19B02D796\",\n    \"Actions\": [\n      {\n        \"GrantItemContent\": {\n          \"CatalogVersion\": \"foo\",\n          \"ItemId\": \"bar\",\n          \"ItemQuantity\": 1\n        }\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/UpdateTask")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Identifier\": {\n    \"Name\": \"PushEventNotificationVIP_Halloween\"\n  },\n  \"Name\": \"PushEventNotificationVIP_Thanksgiving\",\n  \"Description\": \"Send push notification to VIP about Thanksgiving event\",\n  \"Type\": \"ActionsOnPlayerSegment\",\n  \"Parameter\": {\n    \"SegmentId\": \"E2B0F9C19B02D796\",\n    \"Actions\": [\n      {\n        \"GrantItemContent\": {\n          \"CatalogVersion\": \"foo\",\n          \"ItemId\": \"bar\",\n          \"ItemQuantity\": 1\n        }\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/UpdateTask")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Identifier\": {\n    \"Name\": \"PushEventNotificationVIP_Halloween\"\n  },\n  \"Name\": \"PushEventNotificationVIP_Thanksgiving\",\n  \"Description\": \"Send push notification to VIP about Thanksgiving event\",\n  \"Type\": \"ActionsOnPlayerSegment\",\n  \"Parameter\": {\n    \"SegmentId\": \"E2B0F9C19B02D796\",\n    \"Actions\": [\n      {\n        \"GrantItemContent\": {\n          \"CatalogVersion\": \"foo\",\n          \"ItemId\": \"bar\",\n          \"ItemQuantity\": 1\n        }\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Update Task

Error codes

Authorizations

Body

Response