Create a new task in a board

Creates a new task in a board section. You must be a board member with permission to create tasks. If successful, returns the full task details, including assignees, section, board, and available permissions.

Endpoints

post /pulse/api/addTask

Copy full URL

Request URL

https://ServerDomain/pulse/api/addTask

Scope

ZohoPulse.tasks.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Query Parameters

PARAM NAME	DATA TYPE	DESCRIPTION
scopeIDMandatory	Long	Network (scope) ID. Required.
userIds	Long	Comma-separated user IDs to assign. Max 100.
tagIds	Long	Comma-separated tag IDs. Max 50.
boardId	Long	Board ID to create the task in.
sectionId	Long	Section ID to place the task in.
position	Integer	Position index within the section.
titleMandatory	String	Task title. Max 3000 characters. Required.
priority	String	Task priority — None, Low, Medium, or High.
desc	String	Task description. Max 50,000 characters.

Sample Request

Curl

Java

Python

Deluge

Copied!

curl --request POST \
  --url 'https://connect.zoho.com/pulse/api/addTask?scopeID=3000000000008&boardId=3000000050001&sectionId=3000000050010' \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

var client = new RestClient("https://connect.zoho.com/pulse/api/addTask?scopeID=3000000000008&boardId=3000000050001&sectionId=3000000050010");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52");
IRestResponse response = client.Execute(request);

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://connect.zoho.com/pulse/api/addTask?scopeID=3000000000008&boardId=3000000050001&sectionId=3000000050010"))
        .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("connect.zoho.com")

headers = { 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" }

conn.request("POST", "/pulse/api/addTask?scopeID=3000000000008&boardId=3000000050001&sectionId=3000000050010", headers=headers)

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

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


    parameters = "scopeID=value" + "&" + "boardId=value" + "&" + "sectionId=value";

    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://connect.zoho.com/pulse/api/addTask" + "?" + parameters
        type: POST
        headers: headersMap
        connection: connection_name
    ]

    info response;

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

PARAM NAME	DATA TYPE	DESCRIPTION
	JSON Object	Top-level response wrapper for Add Task
addTask	JSON Object	Inner addTask object — post wrapping the task
result	String	Result status — 'failure'. Present on failure.
stream	JSON Object	Full post object via constructStream(). Contains the nested task object plus post-level fields (id, content, author, etc.).
streamUrl	String	URL of the shared link (LINK type).
canFixAtTop	Boolean	True if caller can pin to top (announcements).
comments	JSON Array	Array of comment objects. Present in single-stream views.
	JSON Object	Comment object from constructComment
attachments	JSON Array	Array of attachment objects.
streamId	Long	Parent post ID.
isCurrentUserLiked	Boolean	Whether the current user liked this comment.
canEdit	String	'true' if the current user can edit.
parentCommentId	Long	Parent comment ID (for threaded replies).
likeCount	Integer	Number of likes on this comment.
isPinnedComment	Boolean	Whether the comment is pinned.
userDetails	JSON Object	Comment author details.
		`Refer to streamAuthorObj`
content	String	Comment content (HTML).
formatedTime	String	Formatted creation time string.
streamType	String	Parent post type.
commentType	String	Comment type (COMMENT, ANSWER, etc.).
hasHistory	String	'true' if the comment has been edited.
canDelete	String	'true' if the current user can delete.
id	Long	Comment ID.
time	Long	Creation timestamp (epoch ms).
isApproved	Boolean	Whether the comment is approved.
isReply	String	'true' if this is a reply to another comment.
canLike	String	'true' if caller can like.
author	JSON Object	Post author details.
name	String	Author display name.
hasCustomImg	Boolean	True if author has a custom profile image.
zuid	Long	Author Zoho UID.
canDisablePoll	String	'true' if the caller can disable this poll. Present only for POLL type when the caller is the creator and canEdit.
canEdit	Boolean	True if caller can edit.
link	JSON Object	Link preview details. Present for LINK type.
embedUrl	String	Embeddable video URL.
videoType	String	Video type (if embedded video).
linkurl	String	Shared URL.
title	String	Link title.
desc	String	Link description.
polls	JSON Object	Poll details. Present only for POLL type posts.
canAddVote	String	'true' if the caller can vote (poll not locked, not expired, and vote editable).
canViewVotedUsers	String	'true' if caller can view who voted for each option.
totalVote	Integer	Total number of votes cast. Present when canShowResult is true.
options	JSON Array	Array of poll option objects.
	JSON Object	Fields of a poll option object
		`Refer to pollOptionObj`
voteDisplayType	Integer	Vote display mode: 0=count visible, 1=show after vote, 2=hidden until admin approval.
allowmultiple	String	'true' if voters can select multiple options.
isVoted	Boolean	True if the current user has voted in this poll.
canShowResult	String	'true' if caller can see vote results (creator, admin, or per display rules).
whoCanViewVotedUsers	Integer	0=only creator/admin, 1=everyone. Present when canShowResult is true.
canShowRemoveVote	String	'true' if the caller can remove their vote.
type	String	Post type name — STATUS, ANNOUNCEMENT, QUESTION, IDEA, etc.
title	String	Post title (for titled types: QUESTION, IDEA, ANNOUNCEMENT).
content	String	Rendered HTML content.
commentCount	Integer	Total number of comments.
partition	JSON Object	Target group. Present when posting to a group.
name	String	Partition name.
id	Long	Partition ID.
type	String	Partition type — GROUP, TOWNHALL, CHANNEL, etc.
url	String	Partition URL.
task	JSON Object	Task metadata object. Present only for TASK type posts.
streamId	Long	Associated post ID.
canEdit	String	'true' if caller can edit.
section	JSON Object	Section the task belongs to.
name	String	Section name.
id	Long	Section ID.
isPrivate	Boolean	True if private section.
url	String	Section URL.
colorType	Integer	Section colour index.
shortTitle	String	Truncated task title.
isPrivate	String	'true' if in a private section.
title	String	Task title.
isOverDue	String	'true' if task is past due.
partition	JSON Object	Board the task belongs to.
typeOrd	Integer	Partition type ordinal.
partitionUrl	String	Board URL slug.
isPrivate	Boolean	True if board is private.
isAdmin	String	'true' if caller is board admin.
type	String	Partition type — PROJECT.
url	String	Board URL path.
users	JSON Array	Array of member user IDs.
sections	JSON Array	Array of board sections.
	JSON Object	Board section object (flat in array, no 'section' wrapper per element)
		`Refer to sectionItem`
canCreateSection	String	'false' if caller cannot create sections.
name	String	Board name.
subType	String	Board sub-type (e.g. DEFAULT, SCRUM).
id	Long	Board ID.
isUserFollow	Boolean	True if caller follows the board.
status	String	Entity status (ACTIVE, ARCHIVED, etc.).
canCreateTask	String	'false' if caller cannot create tasks.
percentage	Integer	Completion percentage (0–100).
createdTime	Long	Creation timestamp (epoch ms).
canDelete	String	'true' if caller can delete.
id	Long	Task ID.
formattedCreatedTime	String	Human-readable creation time.
formattedDueDate	String	Human-readable due date.
isCompleted	String	'true' if task is completed.
attachCount	Integer	Number of attachments.
canComplete	String	'true' if caller can complete.
startDateLong	Long	Start-date timestamp (epoch ms).
assigneesCount	Integer	Number of assignees.
priority	String	Priority name (None, Low, Medium, High).
userDetails	JSON Object	Task author details.
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.
formattedStartDate	String	Human-readable start date.
commentCount	Integer	Number of comments.
endDateLong	Long	Due-date timestamp (epoch ms).
canAssign	String	'true' if caller can assign.
subTaskCount	Integer	Number of sub-tasks.
completedSubTaskCount	Integer	Number of completed sub-tasks.
position	Integer	Position within section.
desc	String	Task description text.
status	Integer	TaskStatus ordinal.
isLocked	String	'true' if post is locked.
hasHistory	String	'true' if post has edit history.
canDelete	Boolean	True if caller can delete.
id	Long	Post ID.
canComment	String	'true' if caller can comment.
isApproved	Boolean	Moderation approval status.
event	JSON Object	Event metadata object. Present only for EVENT type posts.
streamId	Long	Associated post ID.
formattedEndTime	String	Human-readable end time. Absent for all-day events.
canEdit	Boolean	True if the caller can edit this event.
canRSVP	String	'true' if the caller can RSVP.
shortTitle	String	Truncated event title.
title	String	Event title.
type	String	Stream type (EVENT, MEETING_EVENT, SHOWTIME_EVENT, etc.).
yesCount	Integer	Number of 'Yes' RSVPs.
isAllDay	String	'true' if all-day event.
isSharedEvent	Boolean	True if the event's group was shared.
startTime	Long	Event start time (epoch ms).
canDelete	Boolean	True if the caller can delete this event.
logoType	Integer	Logo type: 1=uploaded, 2=default.
isRSVPAllowed	Boolean	Whether RSVP is enabled for this event.
invitedUserCount	Integer	Number of invited users.
isStarted	String	'true' if event has started but not ended.
formattedStartTime	String	Human-readable start time. Absent for all-day events.
noCount	Integer	Number of 'No' RSVPs.
location	String	Event location. Absent if not set.
logoModifiedTime	Long	Logo last-modified timestamp. Present when logoType = 1.
isPrivateEvent	Boolean	True if the event is in a member (DM) partition.
endTime	Long	Event end time (epoch ms). Absent if not set.
isExpired	String	'true' if past end time.
logoId	Long	Uploaded logo attachment ID. Present when logoType != 1.
desc	String	Event description.
status	String	Post status — ACTIVE, DRAFT, SCHEDULED, etc.
errorCode	String	Error code. Present on failure.

Possible Response Codes

HTTP Code	Description
200	Success response

Sample Response: HTTP 200

Task created successfully.

Copied!

  {
    "addTask": {
      "stream": {
        "task": {
          "attachCount": 0,
          "streamId": 3000000060002,
          "canComplete": "true",
          "canEdit": "true",
          "section": {
            "name": "To Do",
            "id": 3000000050010,
            "isPrivate": false,
            "colorType": 2
          },
          "assigneesCount": 0,
          "shortTitle": "Implement login page",
          "title": "Implement login page",
          "priority": "High",
          "commentCount": 0,
          "partition": {
            "name": "Sprint Board",
            "id": 3000000050001,
            "type": "PROJECT"
          },
          "canAssign": "true",
          "subTaskCount": 0,
          "percentage": 0,
          "createdTime": 1742464200000,
          "completedSubTaskCount": 0,
          "canDelete": "true",
          "id": 3000000060001,
          "formattedCreatedTime": "Mar 20, 2026 10:30 AM",
          "position": 0,
          "desc": "Build the login page with OAuth support",
          "status": 0
        },
        "id": 3000000060002
      }
    }
  }

▼ 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.