Update a single field of an existing task

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Updates a single field of an existing task, such as the title, description, due date, start date, priority, status, or assignee. Only one field can be updated per request. The response will include details based on the field that was updated.

Endpoints

Request URL

https://ServerDomain/pulse/api/updateTask

Scope

ZohoPulse.tasks.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

PARAM NAMEDATA TYPEDESCRIPTION
scopeIDMandatory Long

Network (scope) ID. Required.

removeAssigneeId Long

Comma-separated user IDs to remove from assignees. Max 50.

isClearStartDate Boolean

If true, removes the start date.

isClearDueDate Boolean

If true, removes the due date.

title String
Allowed value:(matches: (?ims)(.*?))

Updated task title.

priority String
Allowed value:(matches: ^(None|Low|Medium|High)$)

Updated priority — None, Low, Medium, or High.

assigneeId Long

Comma-separated user IDs to add as assignees. Max 50.

taskIdMandatory Long

Task ID to update. Required.

desc String
Allowed value:(matches: (?ims)(.*?))

Updated task description.

status Long

Updated task status as a long value.

Sample Request

Curl
C#
Java
Python
Deluge
Copied!
curl --request POST \
  --url 'https://connect.zoho.com/pulse/api/updateTask?scopeID=3000000000008&taskId=3000000060001' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
PARAM NAMEDATA TYPEDESCRIPTION
updateTask JSON Object

Inner updateTask object — varies by update type. Only one update per call.

completedTime String

Formatted completion time. Present on completion.

startDateLong Long

Start-date timestamp (epoch ms). Present on start-date update.

taskPriority JSON Object

Updated priority object. Present on priority update.

name String

Localized priority name.

id Integer

Priority ordinal.

colorType Integer

Priority colour index.

shortTitle String

Truncated title. Present on title update.

title String

Updated title. Present on title update.

formattedStartDate String

Human-readable start date. Present on start-date update.

isOverDue String

'true' if past due. Present on due-date update.

endDateLong Long

Due-date timestamp (epoch ms). Present on due-date update.

canAssign String

'true' if caller can assign. Present on assignee update.

taskPercentage Long

Completion percentage. Present on status update.

canCompleteCheckList String

Whether sub-task checklist can be completed.

isTodayDue String

'true' if due today. Present on due-date update.

formattedDueDate String

Human-readable due date. Present on due-date update.

taskStatus JSON Object

Updated status object. Present on status update.

name String

Localized status name.

id Integer

Status ordinal.

colorType Integer

Status colour index.

completedBy JSON Object

User who completed the task. Present on completion.

role String

Member role — ADMIN or MEMBER.

name String

Display name.

hasCustomImg Boolean

True if user has a custom profile image.

id Long

Internal user ID.

email String

Email address.

zuid Long

Zoho UID.

status String

Member status — ACTIVE.

desc String

Updated description. Present on description update.

isCompleted String

'true' if completed. Present on status → 100%.

Possible Response Codes

HTTP CodeDescription
200

Success response

Sample Response: HTTP 200

Task priority updated.

Copied!
  {
    "updateTask": {
      "taskPriority": {
        "name": "High",
        "id": 3,
        "colorType": 3
      }
    }
  }
                
Show full

Task title updated successfully.

Copied!
  {
    "updateTask": {
      "shortTitle": "Updated task title",
      "title": "Updated task title"
    }
  }
                
Show full

Task status updated to completed.

Copied!
  {
    "updateTask": {
      "completedTime": "Mar 20, 2026 11:00 AM",
      "taskPercentage": 100,
      "taskStatus": {
        "name": "Closed",
        "id": 1,
        "colorType": 4
      },
      "isCompleted": "true"
    }
  }
                
Show full

Duration: 1 minute | Threshold: 10 | Lock period: 1 minute

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