> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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 |




## OpenAPI

````yaml post /Admin/UpdateTask
openapi: 3.0.0
info:
  version: '260922'
  title: PlayFab Admin API
  description: >-
    APIs for managing title configurations, uploaded Game Server code
    executables, and user data
  termsOfService: https://playfab.com/terms/
  contact:
    url: https://community.playfab.com/index.html
  license:
    name: Apache 2.0
    url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE
servers:
  - url: https://{titleId}.playfabapi.com
    description: PlayFab title endpoint
    variables:
      titleId:
        default: your_title_id
        description: Your PlayFab title ID (hex).
security: []
tags:
  - name: Account Management
    description: Account Management APIs
  - name: Authentication
    description: Authentication APIs
  - name: Characters
    description: Characters APIs
  - name: Content
    description: Content Service APIs
  - name: Custom Server Management
    description: Custom Server Management APIs
  - name: Matchmaking
    description: Matchmaking APIs
  - name: Player Data Management
    description: Player Data Management APIs
  - name: Player Item Management
    description: Player Item Management APIs
  - name: PlayStream
    description: PlayStream Management APIs
  - name: ScheduledTask
    description: Task management APIs
  - name: Segments
    description: Segment management APIs
  - name: Server-Side Cloud Script
    description: Server-Side Cloud Script APIs
  - name: Shared Group Data
    description: Shared Group Data APIs
  - name: Title-Wide Data Management
    description: Title-Wide Data Management APIs
  - name: Xbox Store
    description: Xbox Store APIs
paths:
  /Admin/UpdateTask:
    post:
      tags:
        - ScheduledTask
      summary: Update Task
      description: |
        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 |
      operationId: UpdateTask
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTaskRequest'
        description: >-
          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.
      responses:
        '200':
          $ref: '#/components/responses/EmptyResponse'
        '400':
          $ref: '#/components/responses/ApiErrorWrapper'
      security:
        - SecretKey: []
components:
  schemas:
    UpdateTaskRequest:
      description: >-
        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.
      type: object
      properties:
        CustomTags:
          description: >-
            The optional custom tags associated with the request (e.g. build
            number, external trace identifiers, etc.).
          type: object
        Description:
          description: Description the task
          type: string
        Identifier:
          allOf:
            - $ref: '#/components/schemas/NameIdentifier'
          description: Specify either the task ID or the name of the task to be updated.
        IsActive:
          description: >-
            Whether the schedule is active. Inactive schedule will not trigger
            task execution.
          type: boolean
        Name:
          description: >-
            Name of the task. This is a unique identifier for tasks in the
            title.
          type: string
        Parameter:
          description: >-
            Parameter object specific to the task type. See each task type's
            create API documentation for details.
          type: object
        Schedule:
          description: >-
            Cron expression for the run schedule of the task. The expression
            should be in UTC.
          type: string
        Type:
          allOf:
            - $ref: '#/components/schemas/ScheduledTaskType'
          description: Task type.
      required:
        - Name
        - IsActive
        - Type
      example:
        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
    NameIdentifier:
      description: >-
        Identifier by either name or ID. Note that a name may change due to
        renaming, or reused after being deleted. ID is immutable and unique.
      type: object
      properties:
        Id:
          description: Id Identifier, if present
          type: string
        Name:
          description: Name Identifier, if present
          type: string
      example:
        Name: MyTask
        Id: d739e188-22f6-4d13-a4d5-df2e93d4d2f7
    ScheduledTaskType:
      type: string
      enum:
        - CloudScript
        - ActionsOnPlayerSegment
        - CloudScriptAzureFunctions
        - InsightsScheduledScaling
    EmptyResponse:
      type: object
      properties: {}
    ApiErrorWrapper:
      description: The basic wrapper around every failed API response
      type: object
      properties:
        code:
          description: Numerical HTTP code
          type: integer
        status:
          description: String HTTP code
          type: string
        error:
          description: Playfab error code
          type: string
        errorCode:
          description: Numerical PlayFab error code
          type: integer
        errorMessage:
          description: Description for the PlayFab errorCode
          type: string
        errorDetails:
          description: Detailed description of individual issues with the request object
          type: object
      required:
        - code
        - errorCode
  responses:
    EmptyResponse:
      description: ''
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
                description: >-
                  The Http status code. If X-ReportErrorAsSuccess header is set
                  to true, this will report the actual http error code.
              status:
                type: string
                description: The Http status code as a string.
              data:
                $ref: '#/components/schemas/EmptyResponse'
    ApiErrorWrapper:
      description: This is the outer wrapper for all responses with errors
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorWrapper'
  securitySchemes:
    SecretKey:
      type: apiKey
      in: header
      name: X-SecretKey
      description: >-
        This API requires a title secret key, available to title admins, from
        PlayFab Game Manager.

````

## Related topics

- [Update Task](/api-reference/scheduledtask/update-task.md)
- [Multiplayer tasks](/services/xbox-services/multiplayer/mpsd/how-to/live-mpsd-how-tos.md)
- [Scheduled tasks](/services/playfab/data-analytics/acting-data/scheduled-tasks/index.md)
- [title_updated_task](/services/playfab/api-references/events/Extension/title-updated-task.md)
- [Content update best practices](/build/core-features/common/packaging/packaging-updates.md)
