Update an existing deployment task

Updates the deployment task's template, schedule, broadcast settings, remote offices, media, and resource IDs. The task must not be in a running state.

Endpoints

put /emsapi/osdeployer/tasks/{taskId}

Copy full URL

Request URL

https://{serverurl}/emsapi/osdeployer/tasks/{taskId}

Scope

DesktopCentralCloud.OSDTask.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/deploymentTaskDetails.v1+jsonCopied!

AcceptstringMandatory

application/deploymentTaskCreatedStatus.v1+jsonCopied!

- Path Parameters

taskIdstringMandatory

ID of the OS Deployment task

- Query Parameters

taskTypestringMandatory

Type of deployment task being updated. Determines which fields in the request body are applicable. Required.

- Request Body

application/deploymentTaskDetails.v1+json

JSON Object

Hide Sub-Attributes

taskNamestringMandatory

Display name of the deployment task. Matches uem_fileName regex.

taskDescriptionstringOptional

Free-form description of the task.

templateIDstringMandatory

Deployment template ID that defines the image and post-deployment actions.

authCodestringMandatory

One-time authorization code for agent enrolment. SECRET — never logged.

taskSettingsJSON ObjectMandatory

Broadcast type, bandwidth limit, wait time, and schedule details for the task.

Show Sub-Attributes

bandwidthlongMandatory

Maximum bandwidth per target in kbps (e.g., 64000000).

waitTimestringMandatory

Time in minutes to wait for clients to join before starting transmission.

broadcastTypeintegerMandatory

Broadcast mode: 0 = Unicast, 1 = Multicast.

scheduleDetailsJSON ObjectOptional

Schedule configuration for the task. Optional.

Show Sub-Attributes

schedulerDisabledbooleanOptional

If true, the scheduler is disabled and the task runs immediately when started.

taskTimeZonestringOptional

Time zone for the scheduled run (e.g., Asia/Calcutta).

scheduleTypestringOptional

Frequency of the schedule. Accepted values: Daily, Weekly, Monthly.

dailyTimestringOptional

Date and time for the daily schedule in MM/DD/YYYY, HH:mm format (e.g., 07/09/2026, 16:34).

dailyIntervalTypestringOptional

Daily recurrence pattern. Accepted values: everyDay, weekdays.

notificationEmailstringOptional

Email address to notify on task completion. Pass an empty string to skip notification.

applicableRemoteOfficesarrayOptional

Remote-office IDs the task is allowed to target. Empty = all offices.

remoteOfficeIdlongOptional

Primary remote office that schedules and runs the task.

mediaIdlongOptional

ID of the OS Deployer boot media to be used by the task.

resourceIDsarrayOptional

OS Deployer resource IDs to be targeted by the task.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url 'https://appdomains/emsapi/osdeployer/tasks/{taskId}?taskType=SOME_STRING_VALUE' \
  --header 'Accept: application/deploymentTaskCreatedStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/deploymentTaskDetails.v1+json' \
  --data '{"authCode":"z34U","taskSettings":{"bandwidth":64000000,"waitTime":"10","broadcastType":1},"taskName":"DeploymentTask10","templateID":"1"}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/emsapi/osdeployer/tasks/{taskId}?taskType=SOME_STRING_VALUE"))
        .header("Content-Type", "application/deploymentTaskDetails.v1+json")
        .header("Accept", "application/deploymentTaskCreatedStatus.v1+json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"authCode\":\"z34U\",\"taskSettings\":{\"bandwidth\":64000000,\"waitTime\":\"10\",\"broadcastType\":1},\"taskName\":\"DeploymentTask10\",\"templateID\":\"1\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

payload = "{\"authCode\":\"z34U\",\"taskSettings\":{\"bandwidth\":64000000,\"waitTime\":\"10\",\"broadcastType\":1},\"taskName\":\"DeploymentTask10\",\"templateID\":\"1\"}"

headers = {
    'Content-Type': "application/deploymentTaskDetails.v1+json",
    'Accept': "application/deploymentTaskCreatedStatus.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/emsapi/osdeployer/tasks/{taskId}?taskType=SOME_STRING_VALUE", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    parameters = "taskType=value";

    headersMap = Map();
    headersMap.put("Content-Type", "application/deploymentTaskDetails.v1+json");
    headersMap.put("Accept", "application/deploymentTaskCreatedStatus.v1+json");

    data=Map();
    data.put("authCode","value");
    data_taskSettings=Map();
    data_taskSettings.put("bandwidth","1");
    data_taskSettings.put("waitTime","value");
    data_taskSettings.put("broadcastType","1");
    data.put("taskSettings",data_taskSettings);
    data.put("taskName","value");
    data.put("templateID","value");

    response = invokeUrl
    [
        url: "https://appDomains/emsapi/osdeployer/tasks/{taskId}" + "?" + parameters
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/deploymentTaskDetails.v1+json")
$headers.Add("Accept", "application/deploymentTaskCreatedStatus.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/emsapi/osdeployer/tasks/{taskId}?taskType=SOME_STRING_VALUE' -Method PUT -Headers $headers -ContentType 'application/deploymentTaskDetails.v1+json' -Body '{"authCode":"z34U","taskSettings":{"bandwidth":64000000,"waitTime":"10","broadcastType":1},"taskName":"DeploymentTask10","templateID":"1"}'

Sample Request Body

Update task name, template, auth code, broadcast settings, schedule, and applicable remote offices

Copied!

  {
    "authCode": "z34U",
    "taskSettings": {
      "bandwidth": 64000000,
      "waitTime": "10",
      "broadcastType": 1,
      "scheduleDetails": {
        "dailyTime": "07/09/2026, 16:34",
        "taskTimeZone": "Asia/Calcutta",
        "scheduleType": "Daily",
        "notificationEmail": "",
        "schedulerDisabled": false,
        "dailyIntervalType": "everyDay"
      }
    },
    "taskDescription": "",
    "taskName": "DeploymentTask10",
    "applicableRemoteOffices": [
      "1"
    ],
    "templateID": "1"
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/deploymentTaskCreatedStatus.v1+json

JSON Object

Hide Sub-Attributes

isTaskCommittedboolean

True if the task was successfully updated and committed.

taskIDlong

ID of the updated deployment task.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Task updated

Copied!

  {
    "isTaskCommitted": true,
    "taskID": 200
  }

▼ Show full

Duration: 1 minute | Threshold: 50 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.