Zoho Connect

Team collaboration network. Post to the feed and groups, search and comment on posts, and create and update tasks on boards.

Actions

Action	What it does
Add comment	Comment on a post, or reply to one of its comments.
Create post	Post a conversation, announcement or question to the network feed, or to a group.
Create task	Add a task to a board section.
Delete comment	Delete a comment.
Delete post	Delete a post.
Delete task	Delete a task and its sub-tasks.
Get my profile	Get the connected user's profile in a network.
Get post	Get one post with its comments.
Get task	Get one task with its comments, by the post_id 'Create task' returned.
List boards	List your task boards with their sections.
List comments	List the comments on a post.
List group members	List the members of a group, a page at a time.
List group posts	List a group's posts, newest first.
List groups	List the groups you can see in a network, joined or not.
List network members	List a network's members, clients and external clients, with the ids used to assign tasks.
List networks	List the Zoho Connect networks you belong to, the default first.
List recent posts	List the network feed's most recent posts, newest first.
Search posts	Search a network's posts by words, optionally by group, author and date.
Update post	Change a post's text or title, or turn its comments off or on.
Update task	Change a task's title, description, priority, status or assignees, or clear its dates.

Add comment

Comment on a post, or reply to one of its comments.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Post IDpost_idtextRequired: The post's id, from 'List recent posts', 'Search posts' or 'Create post', or the post's address in Zoho Connect.
ContentcontenttextRequired: The comment. HTML is allowed. Up to 10,000 characters.
Reply to commentreply_to_comment_idtext: Optional. The id of the comment to reply to.

Outputs

A comment on a post.

authorobject: A Zoho Connect user.
contenttext: The comment (rich-text HTML).
formatedTimetext: When it was written, formatted.
idtext: The comment id.
isReplytrue/false: Whether it is a reply.
likeCountnumber: How many likes it has.
parentCommentIdtext: The comment it replies to, or 0.
streamIdtext: The id of the post it is on.
timetext: When it was written.

Example output

{
  "author": {
    "hasCustomImg": true,
    "name": "John Doe",
    "zuid": "700000001"
  },
  "content": "Thanks for the update!",
  "id": "3000000080001",
  "parentCommentId": "0",
  "streamId": "3000000070002"
}

Create post

Post a conversation, announcement or question to the network feed, or to a group.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
ContentcontenttextRequired: The post. HTML is allowed. Up to 30,000 characters.
Post typepost_typetext: Optional. A conversation unless chosen otherwise.One of: STATUS (Conversation), ANNOUNCEMENT, QUESTION.
Titletitletext: Optional. The title of a question or announcement, up to 300 characters.
Groupgroup_idtext: Optional. Post to this group instead of the network feed.
Email everyonenotify_memberstrue/false: Optional. For an announcement: email every member about it.Default: false.
Announcement expiresannouncement_expires_atdate and time: Optional. For an announcement: when it stops being shown.
Turn off commentsdisable_commentstrue/false: Optional. Stop people commenting on the post.Default: false.

Outputs

A Zoho Connect post.

authorobject: A Zoho Connect user.
canCommenttrue/false: Whether the user can comment.
canDeletetrue/false: Whether the user can delete it.
canEdittrue/false: Whether the user can edit it.
commentCountnumber: How many comments it has.
contenttext: The post (rich-text HTML).
idtext: The post id.
partitionobject: Where the post lives: a group, board or the network feed.
statustext: ACTIVE...
streamUrltext: The post's address in Zoho Connect.
titletext: The title, for questions and announcements.
typetext: STATUS, ANNOUNCEMENT, QUESTION, TASK...

Example output

{
  "author": {
    "hasCustomImg": true,
    "name": "John Doe",
    "zuid": "700000001"
  },
  "canComment": true,
  "canDelete": true,
  "canEdit": true,
  "content": "Group update for the engineering team.",
  "id": "3000000070002",
  "partition": {
    "id": "3000000256092",
    "name": "Engineering",
    "type": "GROUP"
  },
  "status": "ACTIVE",
  "type": "STATUS"
}

Create task

Add a task to a board section. Returns its task_id and the post_id of the post carrying it.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Boardboard_idtextRequired: The board.
Sectionsection_idtextRequired: The board section to put the task in.
TitletitletextRequired: The task's title.
Descriptiondescriptiontext: Optional. The task's description.
Priorityprioritytext: Optional. The task's priority.One of: None, Low, Medium, High.
Assigneesassignee_idslist: Optional. Who to assign it to: ids from 'List network members', comma-separated, up to 100.

Outputs

A Zoho Connect task.

assigneesCountnumber: How many people it is assigned to.
boardobject: Where the post lives: a group, board or the network feed.
commentCountnumber: How many comments it has.
createdTimetext: When it was created.
desctext: The task's description.
formattedDueDatetext: The due date, formatted.
formattedStartDatetext: The start date, formatted.
isCompletedtrue/false: Whether the task is done.
isOverDuetrue/false: Whether the task is overdue.
post_idtext: The id of the post carrying the task, used to get it.
prioritytext: The priority.
sectionobject: The board section.
statusnumber: The status: 0 open, 1 closed.
task_idtext: The task id, used to update or delete the task.
titletext: The task's title.

Example output

{
  "board": {
    "id": "3000000300001",
    "name": "Launch",
    "type": "PROJECT"
  },
  "id": "3000000060001",
  "isCompleted": false,
  "post_id": "3000000060002",
  "priority": "Medium",
  "section": {
    "id": "3000000300011",
    "name": "To do"
  },
  "status": 0,
  "streamId": "3000000060002",
  "task_id": "3000000060001",
  "title": "Prepare the launch notes"
}

Delete comment

Delete a comment. This cannot be undone.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Comment IDcomment_idtextRequired: The comment's id, from 'List comments' or 'Add comment'.

Outputs

The deleted comment.

comment_idtext: The comment id.
deletedtrue/false: Always true.

Example output

{
  "comment_id": "3000000080001",
  "deleted": true
}

Delete post

Delete a post. This cannot be undone.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Post IDpost_idtextRequired: The post's id, from 'List recent posts', 'Search posts' or 'Create post', or the post's address in Zoho Connect.

Outputs

The deleted post.

deletedtrue/false: Always true.
post_idtext: The post id.

Example output

{
  "deleted": true,
  "post_id": "3000000070002"
}

Delete task

Delete a task and its sub-tasks. This cannot be undone.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Task IDtask_idtextRequired: The task_id that 'Create task' returned (not the post_id).

Outputs

The deleted task.

deletedtrue/false: Always true.
task_idtext: The task id.

Example output

{
  "deleted": true,
  "task_id": "3000000060001"
}

Get my profile

Get the connected user's profile in a network.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.

Outputs

The connected user's profile in the network.

aboutMetext: About me.
departmenttext: Department.
designationtext: Job title.
emailIdtext: Email address.
employeeIdtext: Employee id.
firstNametext: First name.
followerCountnumber: How many people follow the user.
followingCountnumber: How many people the user follows.
lastNametext: Last name.
mobiletext: Mobile number.
nametext: Display name.
partitionIdtext: The id of the user's own feed.
typetext: The kind of user.
userStatustext: active, disabled or inactive.
workLocationtext: Work location.
zuidtext: The user's Zoho account id (ZUID).

Example output

{
  "emailId": "john@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "name": "John Doe",
  "userStatus": "active",
  "zuid": "700000001"
}

Get post

Get one post with its comments.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Post IDpost_idtextRequired: The post's id, from 'List recent posts', 'Search posts' or 'Create post', or the post's address in Zoho Connect.

Outputs

A Zoho Connect post with its comments.

authorobject: A Zoho Connect user.
canCommenttrue/false: Whether the user can comment.
canDeletetrue/false: Whether the user can delete it.
canEdittrue/false: Whether the user can edit it.
commentCountnumber: How many comments it has.
commentslist: The post's comments.
contenttext: The post (rich-text HTML).
idtext: The post id.
partitionobject: Where the post lives: a group, board or the network feed.
statustext: ACTIVE...
streamUrltext: The post's address in Zoho Connect.
titletext: The title, for questions and announcements.
typetext: STATUS, ANNOUNCEMENT, QUESTION, TASK...

Example output

{
  "author": {
    "hasCustomImg": true,
    "name": "John Doe",
    "zuid": "700000001"
  },
  "canComment": true,
  "canDelete": true,
  "canEdit": true,
  "comments": [
    {
      "author": {
        "hasCustomImg": true,
        "name": "John Doe",
        "zuid": "700000001"
      },
      "content": "Thanks for the update!",
      "id": "3000000080001",
      "parentCommentId": "0",
      "streamId": "3000000070002"
    }
  ],
  "content": "Group update for the engineering team.",
  "id": "3000000070002",
  "partition": {
    "id": "3000000256092",
    "name": "Engineering",
    "type": "GROUP"
  },
  "status": "ACTIVE",
  "type": "STATUS"
}

Get task

Get one task with its comments, by the post_id 'Create task' returned.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Task post IDpost_idtextRequired: The post_id that 'Create task' returned (the post carrying the task), not the task_id.

Outputs

A Zoho Connect task with its comments.

assigneesCountnumber: How many people it is assigned to.
boardobject: Where the post lives: a group, board or the network feed.
commentCountnumber: How many comments it has.
comment_countnumber: How many comments it has.
commentslist: The task's comments.
createdTimetext: When it was created.
desctext: The task's description.
formattedDueDatetext: The due date, formatted.
formattedStartDatetext: The start date, formatted.
isCompletedtrue/false: Whether the task is done.
isOverDuetrue/false: Whether the task is overdue.
post_idtext: The id of the post carrying the task, used to get it.
prioritytext: The priority.
sectionobject: The board section.
statusnumber: The status: 0 open, 1 closed.
task_idtext: The task id, used to update or delete the task.
titletext: The task's title.

Example output

{
  "board": {
    "id": "3000000300001",
    "name": "Launch",
    "type": "PROJECT"
  },
  "comment_count": 0,
  "comments": [],
  "id": "3000000060001",
  "isCompleted": false,
  "post_id": "3000000060002",
  "priority": "Medium",
  "section": {
    "id": "3000000300011",
    "name": "To do"
  },
  "status": 0,
  "streamId": "3000000060002",
  "task_id": "3000000060001",
  "title": "Prepare the launch notes"
}

List boards

List your task boards with their sections.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.

Outputs

countnumber: How many boards were returned.
default_prioritieslist: Task priorities.
default_statuseslist: Task statuses: Open (0) and Closed (1).
itemslist: The boards.
sectionslist: Every board's sections, with board_id.

Example output

{
  "count": 1,
  "default_priorities": [
    {
      "id": 0,
      "name": "None"
    },
    {
      "id": 3,
      "name": "High"
    }
  ],
  "default_statuses": [
    {
      "id": 0,
      "name": "Open"
    },
    {
      "id": 1,
      "name": "Closed"
    }
  ],
  "items": [
    {
      "canCreateTask": true,
      "id": "3000000300001",
      "name": "Launch",
      "sections": [
        {
          "id": "3000000300011",
          "name": "To do",
          "taskCount": 3
        }
      ],
      "type": "PROJECT"
    }
  ],
  "sections": [
    {
      "board_id": "3000000300001",
      "board_name": "Launch",
      "id": "3000000300011",
      "name": "To do",
      "taskCount": 3
    }
  ]
}

List comments

List the comments on a post.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Post IDpost_idtextRequired: The post's id, from 'List recent posts', 'Search posts' or 'Create post', or the post's address in Zoho Connect.
Viewviewtext: Optional. Threaded, or newest first.One of: THREAD (Threaded), RECENT (Newest first).

Outputs

countnumber: How many comments were returned.
itemslist: The comments.

Example output

{
  "count": 1,
  "items": [
    {
      "author": {
        "hasCustomImg": true,
        "name": "John Doe",
        "zuid": "700000001"
      },
      "content": "Thanks for the update!",
      "id": "3000000080001",
      "parentCommentId": "0",
      "streamId": "3000000070002"
    }
  ]
}

List group members

List the members of a group, a page at a time.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Groupgroup_idtextRequired: The group.
Pagepagenumber: Optional. The next_page of the previous result; 0 for the first.At least 0.

Outputs

countnumber: How many group members were returned.
has_moretrue/false: Whether another page is available.
itemslist: The group members.
next_pagenumber: The page to ask for next.
totalnumber: How many members the group has.

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "emailId": "john@example.com",
      "id": "700000001",
      "name": "John Doe",
      "role": "MEMBER",
      "type": "C",
      "zuid": "700000001"
    }
  ],
  "next_page": null,
  "total": 1
}

List group posts

List a group's posts, newest first.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Groupgroup_idtextRequired: The group.
Page sizelimitnumber: Optional. How many to return, 5 to 30. Default 20.From 5 to 30.
Cursorcursortext: Optional. The next_cursor of the previous page, for older posts.

Outputs

countnumber: How many posts were returned.
has_moretrue/false: Whether there may be older posts.
itemslist: The posts.
next_cursortext: Pass as Cursor to get the next, older page.

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "author": {
        "hasCustomImg": true,
        "name": "John Doe",
        "zuid": "700000001"
      },
      "canComment": true,
      "canDelete": true,
      "canEdit": true,
      "content": "Group update for the engineering team.",
      "id": "3000000070002",
      "partition": {
        "id": "3000000256092",
        "name": "Engineering",
        "type": "GROUP"
      },
      "status": "ACTIVE",
      "type": "STATUS"
    }
  ],
  "next_cursor": "1700000000000"
}

List groups

List the groups you can see in a network, joined or not.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Include Company Wallinclude_company_walltrue/false: Optional. Also list the network's Company Wall.Default: false.
Maximumlimitnumber: Optional. At most this many groups.At least 1.

Outputs

countnumber: How many groups were returned.
itemslist: The groups.

Example output

{
  "count": 1,
  "items": [
    {
      "accessType": "OPEN_PUBLIC",
      "id": "3000000256092",
      "isJoined": true,
      "name": "Engineering",
      "role": "MEMBER",
      "status": "ACTIVE",
      "type": "GROUP"
    }
  ]
}

List network members

List a network's members, clients and external clients, with the ids used to assign tasks.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Changed aftermodified_afterdate and time: Optional. Only members changed after this moment.

Outputs

clients_countnumber: How many are clients or external clients.
countnumber: How many members, clients and external clients were returned.
itemslist: The members, clients and external clients.
users_countnumber: How many are members.

Example output

{
  "clients_count": 0,
  "count": 1,
  "items": [
    {
      "emailId": "john@example.com",
      "id": "700000001",
      "name": "John Doe",
      "type": "C"
    }
  ],
  "users_count": 1
}

List networks

List the Zoho Connect networks you belong to, the default first.

Inputs

Admin onlyadmin_onlytrue/false: Optional. Only networks you administer.Default: false.

Outputs

countnumber: How many networks were returned.
itemslist: The networks.

Example output

{
  "count": 1,
  "items": [
    {
      "id": "3000000000008",
      "isDefault": true,
      "name": "Zillium",
      "soid": "38523447",
      "url": "https://connect.zoho.com/portal/zillium",
      "zoid": "15065798"
    }
  ]
}

List recent posts

List the network feed's most recent posts, newest first.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Post typepost_typetext: Optional. Only posts of this type.One of: STATUS (Conversation), ANNOUNCEMENT, QUESTION, POLL.
Page sizelimitnumber: Optional. How many to return, 10 to 30. Default 20.From 10 to 30.
Cursorcursortext: Optional. The next_cursor of the previous page, for older posts.

Outputs

countnumber: How many posts were returned.
has_moretrue/false: Whether there may be older posts.
itemslist: The posts.
next_cursortext: Pass as Cursor to get the next, older page.

Example output

{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "author": {
        "hasCustomImg": true,
        "name": "John Doe",
        "zuid": "700000001"
      },
      "canComment": true,
      "canDelete": true,
      "canEdit": true,
      "content": "Group update for the engineering team.",
      "id": "3000000070002",
      "partition": {
        "id": "3000000256092",
        "name": "Engineering",
        "type": "GROUP"
      },
      "status": "ACTIVE",
      "type": "STATUS"
    }
  ],
  "next_cursor": "1700000000000"
}

Search posts

Search a network's posts by words, optionally by group, author and date.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
QueryquerytextRequired: The words to search for.
Groupgroup_idtext: Optional. Only posts in this group.
Author IDauthor_idtext: Optional. Only posts by this person: an id from 'List network members'.
Sort bysort_bytext: Optional. Best match or newest first.One of: date (Newest first), relevance (Best match).
Fromfrom_datedate: Optional. Only posts from this day on.
Toto_datedate: Optional. Only posts up to this day.
Pagepagenumber: Optional. The page to return; 0 for the first.At least 0.

Outputs

countnumber: How many matching posts were returned.
itemslist: The matching posts.
page_indexnumber: The page index Zoho Connect reported.

Example output

{
  "count": 1,
  "items": [
    {
      "author": {
        "hasCustomImg": true,
        "name": "John Doe",
        "zuid": "700000001"
      },
      "canComment": true,
      "canDelete": true,
      "canEdit": true,
      "content": "Group update for the engineering team.",
      "id": "3000000070002",
      "partition": {
        "id": "3000000256092",
        "name": "Engineering",
        "type": "GROUP"
      },
      "status": "ACTIVE",
      "type": "STATUS"
    }
  ],
  "page_index": 1
}

Update post

Change a post's text or title, or turn its comments off or on.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Post IDpost_idtextRequired: The post's id, from 'List recent posts', 'Search posts' or 'Create post', or the post's address in Zoho Connect.
Contentcontenttext: Optional. The new text. HTML is allowed. Up to 30,000 characters.
Titletitletext: Optional. The new title, up to 300 characters.
Turn off commentsdisable_commentstrue/false: Optional. True to stop comments, false to allow them.

Outputs

A Zoho Connect post.

authorobject: A Zoho Connect user.
canCommenttrue/false: Whether the user can comment.
canDeletetrue/false: Whether the user can delete it.
canEdittrue/false: Whether the user can edit it.
commentCountnumber: How many comments it has.
contenttext: The post (rich-text HTML).
idtext: The post id.
partitionobject: Where the post lives: a group, board or the network feed.
statustext: ACTIVE...
streamUrltext: The post's address in Zoho Connect.
titletext: The title, for questions and announcements.
typetext: STATUS, ANNOUNCEMENT, QUESTION, TASK...

Example output

{
  "author": {
    "hasCustomImg": true,
    "name": "John Doe",
    "zuid": "700000001"
  },
  "canComment": true,
  "canDelete": true,
  "canEdit": true,
  "content": "Group update for the engineering team.",
  "id": "3000000070002",
  "partition": {
    "id": "3000000256092",
    "name": "Engineering",
    "type": "GROUP"
  },
  "status": "ACTIVE",
  "type": "STATUS"
}

Update task

Change a task's title, description, priority, status or assignees, or clear its dates. Only the fields given change.

Inputs

Networkscope_idtextRequired: The Zoho Connect network to work in.
Task IDtask_idtextRequired: The task_id that 'Create task' returned (not the post_id).
Titletitletext: Optional. The new title.
Descriptiondescriptiontext: Optional. The new description.
Priorityprioritytext: Optional. The task's priority.One of: None, Low, Medium, High.
Statusstatustext: Optional. Open or Closed.One of: Open, Closed.
Add assigneesadd_assignee_idslist: Optional. Ids from 'List network members' to assign, up to 50.
Remove assigneesremove_assignee_idslist: Optional. Ids of assignees to remove, up to 50.
Clear start dateclear_start_datetrue/false: Optional. Remove the task's start date.Default: false.
Clear due dateclear_due_datetrue/false: Optional. Remove the task's due date.Default: false.

Outputs

What Zoho Connect reports for the fields changed.

desctext: The description.
formattedDueDatetext: The due date, formatted.
formattedStartDatetext: The start date, formatted.
isCompletedtrue/false: Whether the task is done.
taskPriorityobject: A named value.
taskStatusobject: A named value.
task_idtext: The task id.
titletext: The title.
updated_fieldslist: The fields changed, in order.

Example output

{
  "taskPriority": {
    "id": 3,
    "name": "High"
  },
  "task_id": "3000000060001",
  "updated_fields": [
    "priority"
  ]
}

ActionsCopy Anchor Link

Add commentCopy Anchor Link

Inputs

Outputs

Create postCopy Anchor Link

Inputs

Outputs

Create taskCopy Anchor Link

Inputs

Outputs

Delete commentCopy Anchor Link

Inputs

Outputs

Delete postCopy Anchor Link

Inputs

Outputs

Delete taskCopy Anchor Link

Inputs

Outputs

Get my profileCopy Anchor Link

Inputs

Outputs

Get postCopy Anchor Link

Inputs

Outputs

Get taskCopy Anchor Link

Inputs

Outputs

List boardsCopy Anchor Link

Inputs

Outputs

List commentsCopy Anchor Link

Inputs

Outputs

List group membersCopy Anchor Link

Inputs

Outputs

List group postsCopy Anchor Link

Inputs

Outputs

List groupsCopy Anchor Link

Inputs

Outputs

List network membersCopy Anchor Link

Inputs

Outputs

List networksCopy Anchor Link

Inputs

Outputs

List recent postsCopy Anchor Link

Inputs

Outputs

Search postsCopy Anchor Link

Inputs

Outputs

Update postCopy Anchor Link

Inputs

Outputs

Update taskCopy Anchor Link

Inputs

Outputs

On this page

Actions

Add comment

Create post

Create task

Delete comment

Delete post

Delete task

Get my profile

Get post

Get task

List boards

List comments

List group members

List group posts

List groups

List network members

List networks

List recent posts

Search posts

Update post

Update task