# Zoho Connect Integration via LowCodeAPI
## Overview
Integration platform
## Base Endpoint
```
https://api.lowcodeapi.com/zohoconnect/
```
## Authentication
LowCodeAPI handles authentication automatically. You only need to:
1. **Sign up** at [Zoho Connect](https://www.zoho.com/connect)
2. **Get your credentials** from [credential page](https://accounts.zoho.com/developerconsole)
3. **Connect your account** in LowCodeAPI dashboard
4. **Use your `api_token`** in all requests
**Auth Type**: OAUTH2.0
## API Categories
- **Events** - 8 endpoints
- **Feeds** - 12 endpoints
- **Forums** - 4 endpoints
- **Groups** - 10 endpoints
- **Manuals** - 7 endpoints
- **Network** - 4 endpoints
- **Tasks & Boards** - 13 endpoints
- **User** - 3 endpoints
## Common Endpoints
### Category: Events
#### Create Event
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/addevent`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/addevent?api_token={api_token}
```
**Description**: The purpose of this API is to create an event in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"title": "<string>",
"startYear": "<string>",
"startMonth": "<string>",
"startDate": "<string>",
"startHour": "<string>",
"startMin": "<string>",
"endYear": "<string>",
"endMonth": "<string>",
"endDate": "<string>",
"endHour": "<string>",
"endMin": "<string>"
}
```
---
#### Add Event Attendees
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/addeventinvitees`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/addeventinvitees?api_token={api_token}
```
**Description**: The purpose of this API is to add invitees to an event in Zoho Connect network
**Request Body**:
```json
{
"scopeID": "<string>",
"streamId ": "<string>",
"invitedMembers": "<string>"
}
```
---
#### Add Event Reminder
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/addeventreminder`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/addeventreminder?api_token={api_token}
```
**Description**: The purpose of this API is to add event attendees in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"streamId": "<string>"
}
```
---
#### Delete Event
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/deleteevent`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/deleteevent?scopeID={scopeID}&streamId={streamId}&api_token={api_token}
```
**Description**: The purpose of this API is to delete an event from Zoho Connect network
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | Network in which the event is to be deleted |
|`streamId` | string | Yes | Stream ID to delete event |
---
#### Get upcoming events
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/upcomingevents`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/upcomingevents?scopeID={scopeID}&selectedPartIds={selectedPartIds}&partitionId={partitionId}&startTime={startTime}&endTime={endTime}&sharedWithMe={sharedWithMe}&partitionType={partitionType}&partitionUrl={partitionUrl}&api_token={api_token}
```
**Description**: The purpose of this API is to get the list of all upcoming events in a Zoho Connect network
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the events are in |
|`selectedPartIds` | string | Yes | Group IDs separated by a comma |
|`partitionId` | string | Yes | Group ID |
|`startTime` | string | No | Fetch data from the specified time |
|`endTime` | string | No | Fetch data till the specified time |
|`sharedWithMe` | string | No | Get only events that the user has been invited to |
|`partitionType` | string | Yes | If partitionId or selectedPartIds is not given, then this field has to be specified: (GROUP | DEFAULT) |
|`partitionUrl` | string | Yes | If partitionId or selectedPartIds is not given, then this field has to be specified |
---
#### Remove Event Reminder
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/deleteeventreminder`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/deleteeventreminder?scopeID={scopeID}&streamId={streamId}&api_token={api_token}
```
**Description**: The purpose of this API is to remove reminders from an event in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | Network in which the event reminder is to be deleted |
|`streamId` | string | Yes | stream ID to delete reminder |
---
#### Removing event attendees
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/deleteeventinvitees`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/deleteeventinvitees?scopeID={scopeID}&streamId={streamId}&invitedMembers={invitedMembers}&invitedGroups={invitedGroups}&api_token={api_token}
```
**Description**: The purpose of this API is to remove attendees from an event in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | Network in which the event is to be updated |
|`streamId` | string | Yes | Stream ID to add invitees |
|`invitedMembers` | string | No | IDs of members to be removed as invitees |
|`invitedGroups` | string | No | IDs of groups to be removed as invitees |
---
#### Update Event
**Method**: `PUT` | **LowCodeAPI Path**: `/pulse/api/updateevent`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/updateevent?api_token={api_token}
```
**Description**: The purpose of this API is to update an event in a Zoho Connect network
**Request Body**:
```json
{
"scopeID": "<string>",
"streamId": "<string>",
"title": "<string>",
"startYear": "<string>",
"startMonth": "<string>",
"startDate": "<string>",
"startHour": "<string>",
"startMin": "<string>",
"endYear": "<string>",
"endMonth": "<string>",
"endDate": "<string>",
"endHour": "<string>",
"endMin": "<string>"
}
```
---
### Category: Feeds
#### Create an Announcement
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/v2/addstream`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/v2/addstream?api_token={api_token}
```
**Description**: To purpose of this API is to create a new announcement in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"partitionID": "<string>",
"streamContent": "<string>",
"streamTitle": "<string>",
"streamType": "<string>",
"isAnnouncement": "<string>"
}
```
---
#### Creating a Poll
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/addpoll`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/addpoll?api_token={api_token}
```
**Description**: The purpose of this API is to create a poll in a Zoho Connect network
**Request Body**:
```json
{
"scopeID": "<string>",
"question ": "<string>",
"textOptions": "<string>",
"voteDisplayType": "<string>"
}
```
---
#### Get Single Feed
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/v1/singlestream`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/v1/singlestream?scopeID={scopeID}&streamId={streamId}&streamUrl={streamUrl}&commentIndex={commentIndex}&commentLimit={commentLimit}&isThread={isThread}&needAllComments={needAllComments}&api_token={api_token}
```
**Description**: The purpose of this API is to get the details of a single post in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | Network in which the post was made |
|`streamId` | string | Yes | Get the post by id |
|`streamUrl` | string | No | You can also fetch the post by URL |
|`commentIndex` | string | No | Start an index for comments. The default will be 0 |
|`commentLimit` | string | No | Set a limit on the number of comments |
|`isThread` | string | No | Normal view or threaded view(the replies will be nested into comments json) |
|`needAllComments` | string | No | Show all comments or not. |
---
#### Adding a Comment
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/v2/addcomment`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/v2/addcomment?api_token={api_token}
```
**Description**: The purpose of this API is to add a comment to a post in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"streamId": "<string>",
"commentContent": "<string>"
}
```
---
#### Delete a Feed
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/deletestream`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/deletestream?scopeID={scopeID}&streamId={streamId}&api_token={api_token}
```
**Description**: The purpose of this API is to delete a feed in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the Network the post has been made in |
|`streamId` | string | Yes | ID of the post to be deleted |
---
#### Fetch Feeds by ID
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/streams`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/streams?scopeID={scopeID}&streamId={streamId}&partitionId={partitionId}&commentLimit={commentLimit}&api_token={api_token}
```
**Description**: To fetch streams based on streamId
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the posts have been made in |
|`streamId` | string | Yes | IDs of posts you want to fetch |
|`partitionId` | string | No | IDs of posts you want to fetch |
|`commentLimit` | string | No | Fetch comments based on a number limit |
---
#### Get feeds from My Feed
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/v1/recentstreams`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/v1/recentstreams?scopeID={scopeID}&streamLimit={streamLimit}&commentLimit={commentLimit}&modifiedTime={modifiedTime}&showUserDetails={showUserDetails}&api_token={api_token}
```
**Description**: The purpose of this API is to get posts from the My Feed page
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network in which the posts are made |
|`streamLimit` | string | No | Fetch feeds based on a limit |
|`commentLimit` | string | No | Fetch comments based on a limit |
|`modifiedTime` | string | No | Fetch posts made till a specified time |
|`showUserDetails` | string | No | You can show or hide user details |
---
#### Get Latest Comment
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/latestpartitioncomments`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/latestpartitioncomments?scopeID={scopeID}&partitionId={partitionId}&lastViewedTime={lastViewedTime}&api_token={api_token}
```
**Description**: The purpose of this API is to get the latest comments from a group in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the group belongs to |
|`partitionId` | string | Yes | ID of the Group you need to fetch the comments from |
|`lastViewedTime` | string | Yes | Fetch data after a specified time |
---
#### Get Latest Group Feeds
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/latestpartitionstreams`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/latestpartitionstreams?scopeID={scopeID}&partitionId={partitionId}&lastViewedTime ={lastViewedTime }&api_token={api_token}
```
**Description**: The purpose of this API is to get the latest group feeds in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | Network id |
|`partitionId` | string | Yes | group id |
|`lastViewedTime ` | string | Yes | Fetch data after the given time |
---
#### Get My Feed & Group Feed
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/getlateststreams`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/getlateststreams?scopeID={scopeID}&partition={partition}&lastViewedTime ={lastViewedTime }&streamLimit={streamLimit}&fetchTime={fetchTime}&api_token={api_token}
```
**Description**: The purpose of this API is to get recent posts made in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the posts have been made in |
|`partition` | string | No | ID of the group the posts have been made in |
|`lastViewedTime ` | string | Yes | Fetch data after a specified time |
|`streamLimit` | string | No | Set a limit for the posts |
|`fetchTime` | string | No | Fetch data till a specified time |
---
#### Get poll results
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/votedmembers`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/votedmembers?api_token={api_token}
```
**Description**: The purpose of this API is to get the results of a poll in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"optionId ": "<string>"
}
```
---
#### Update Feed & Poll Preferences
**Method**: `PUT` | **LowCodeAPI Path**: `/pulse/api/updatestream`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/updatestream?api_token={api_token}
```
**Description**: The purpose of this API is to update feed or poll preferences in Zoho Connect
**Request Body**:
```json
{
"streamId": "<string>",
"scopeID": "<string>",
"streamContent": "<string>"
}
```
---
### Category: Forums
#### Create a Forum Post
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/addblog`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/addblog?api_token={api_token}
```
**Description**: The purpose of this API is to create a forum post in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"title": "<string>",
"content": "<string>",
"disableComments": "<string>",
"isPublished": "<string>"
}
```
---
#### Get Recent Forums
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/recentblogs`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/recentblogs?scopeID={scopeID}&pageIndex={pageIndex}&limit={limit}&lastBlogCreatedTime={lastBlogCreatedTime}&categoryId={categoryId}&categoryUrl={categoryUrl}&api_token={api_token}
```
**Description**: The purpose of this API is to get the recent forum posts in Zoho Connec
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the post has been made in |
|`pageIndex` | string | No | Start index to fetch posts |
|`limit` | string | No | End limit |
|`lastBlogCreatedTime` | string | No | Fetch posts from the specified time |
|`categoryId` | string | No | Filter by category ID |
|`categoryUrl` | string | No | Filter by category URL |
---
#### Publish a Forum
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/publishblog`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/publishblog?api_token={api_token}
```
**Description**: The purpose of this API is to publish a forum in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"blogId": "<string>"
}
```
---
#### Update a Forum
**Method**: `PUT` | **LowCodeAPI Path**: `/pulse/api/updateblog`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/updateblog?api_token={api_token}
```
**Description**: The purpose of this API is to update a forum in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"title": "<string>",
"content": "<string>",
"blogId": "<string>"
}
```
---
### Category: Groups
#### Get all Groups
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/allgroups`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/allgroups?scopeID={scopeID}&isRecentSort={isRecentSort}&api_token={api_token}
```
**Description**: The purpose of this API is to get all groups in Zoho Connect network
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the groups have been created in. You can get this from the Network list API |
|`isRecentSort` | string | No | Sort groups based on recency. Se this as true or false |
---
#### Creat a Group
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/addgroup`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/addgroup?api_token={api_token}
```
**Description**: The purpose of this API is to create a group in Zoho Connect network
**Request Body**:
```json
{
"scopeID": "<string>",
"name": "<string>"
}
```
---
#### Update Group Details
**Method**: `PUT` | **LowCodeAPI Path**: `/pulse/api/updategroupdetails`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/updategroupdetails?api_token={api_token}
```
**Description**: The purpose of this API is to update a group's details in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"partitionId": "<string>"
}
```
---
#### Join a Group
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/joingroup`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/joingroup?api_token={api_token}
```
**Description**: The purpose of this API is to join a group in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"partitionId": "<string>"
}
```
---
#### Leave Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/leavegroup`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/leavegroup?scopeID={scopeID}&partitionld={partitionld}&api_token={api_token}
```
**Description**: The purpose of this API is to leave a group in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the group belongs to. You can get this from the Network list API. |
|`partitionld` | string | Yes | ID of the Group you want to leave |
---
#### Add User Role in a Group
**Method**: `POST` | **LowCodeAPI Path**: `zohopulse.grouplist.create`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnectzohopulse.grouplist.create?api_token={api_token}
```
**Description**: The purpose of this API is to add users to a group in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"partitionld": "<string>"
}
```
---
#### Change User Role in a Group
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/changeuserroleingroup`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/changeuserroleingroup?api_token={api_token}
```
**Description**: The purpose of this API is to change user role in a group in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"partitionld": "<string>",
"userId": "<string>",
"role": "<string>"
}
```
---
#### Remove User from a Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/removeuserfromgroup`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/removeuserfromgroup?scopeID={scopeID}&partitionld={partitionld}&userId={userId}&api_token={api_token}
```
**Description**: The purpose of this API is to remove a user from a group in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the group is in |
|`partitionld` | string | Yes | ID of the group to remove members from |
|`userId` | string | Yes | User ID to be removed |
---
#### Archive & Un-archive a Group
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/changepartitionstatus`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/changepartitionstatus?api_token={api_token}
```
**Description**: The purpose of this API is to archive/un-archive a group on Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"partitionld": "<string>",
"isarchive": "<string>",
"isactive": "<string>"
}
```
---
#### Delete Group
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/deletepartition`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/deletepartition?scopeID={scopeID}&partitionld={partitionld}&api_token={api_token}
```
**Description**: The purpose of this API is to delete a group from Zoho Connect network
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the group is in |
|`partitionld` | string | Yes | Group ID to delete |
---
### Category: Manuals
#### Get My Manuals
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/mymanuals`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/mymanuals?scopeID={scopeID}&sortBy={sortBy}&isAscSort={isAscSort}&api_token={api_token}
```
**Description**: The purpose of this API is to get my manuals in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | D of the network the manual is in |
|`sortBy` | string | No | You can sort the manuals alphabetically or by recently created ones |
|`isAscSort` | string | No | Set this as either true or false |
---
#### Get My Articles
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/myarticles`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/myarticles?scopeID={scopeID}&sortBy={sortBy}&isAscSort={isAscSort}&api_token={api_token}
```
**Description**: The purpose of this API is to get 'My Articles' in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the articles are in |
|`sortBy` | string | No | You can sort the articles alphabetically or by recency |
|`isAscSort` | string | No | Set this as true or false |
---
#### Publish a Manual
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/publishmanual`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/publishmanual?api_token={api_token}
```
**Description**: The purpose of this API is to publish a manual in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"manualId": "<string>",
"partitionId ": "<string>"
}
```
---
#### Get Group Articals
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/partitionarticles`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/partitionarticles?scopeID={scopeID}&partitionId={partitionId}&url={url}&sortBy={sortBy}&isAscSort={isAscSort}&api_token={api_token}
```
**Description**: The purpose of this API is to get Articles in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the articles are in |
|`partitionId` | string | Yes | ID of the Group the articles are in |
|`url` | string | No | URL of the Group |
|`sortBy` | string | No | You can sort the Articles alphabetically or by recency |
|`isAscSort` | string | No | Set this as either true or false |
---
#### Get Group Manuals
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/partitionmanuals`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/partitionmanuals?scopeID={scopeID}&partitionId={partitionId}&url={url}&sortBy={sortBy}&isAscSort={isAscSort}&api_token={api_token}
```
**Description**: The purpose of this manual is to get manuals from a group in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the Manual is in |
|`partitionId` | string | Yes | ID of the group to get manuals from |
|`url` | string | No | Group URL |
|`sortBy` | string | No | You can sort the Manuals alphabetically or by recency |
|`isAscSort` | string | No | Set this as either true or false |
---
#### Get User Following Articles
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/followingmanuals`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/followingmanuals?scopeID={scopeID}&sortBy={sortBy}&isAscSort={isAscSort}&api_token={api_token}
```
**Description**: The purpose of this manual is to get manuals followed by the user in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the Manual is in |
|`sortBy` | string | No | You can sort the Manuals alphabetically or by recency |
|`isAscSort` | string | No | Set this as either true or false |
---
#### Publish an Article
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/publisharticle`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/publisharticle?api_token={api_token}
```
**Description**: The purpose of this API is to publish an article in a manual in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"articleId": "<string>"
}
```
---
### Category: Network
#### Get all Networks
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/allscopes`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/allscopes?api_token={api_token}
```
**Description**: The purpose of this API is to get all networks from Zoho Connect
---
#### Get all network members
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/orgmembers`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/orgmembers?scopeID={scopeID}&api_token={api_token}
```
**Description**: The purpose of this API is to get all network members from Zoho Connect Network
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | Network ID |
---
#### Invite users to a network
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/inviteuserstonetwork`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/inviteuserstonetwork?api_token={api_token}
```
**Description**: The purpose of this API is to invite users to a network in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"emailIds": "<string>",
"partitionIds": "<string>"
}
```
---
#### Delete User from an External Network
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/deleteuserfromnetwork`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/deleteuserfromnetwork?api_token={api_token}
```
**Description**: The purpose of this API is to delete a user from a Zoho Connect external network
**Request Body**:
```json
{
"scopeID": "<string>",
"userId": "<string>",
"emailId": "<string>"
}
```
---
### Category: Tasks & Boards
#### Create a board
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/addboard`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/addboard?api_token={api_token}
```
**Description**: The purpose of this API is to create a board in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"name": "<string>",
"desc": "<string>"
}
```
---
#### Add Members to a Board
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/addmemberstoboard`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/addmemberstoboard?api_token={api_token}
```
**Description**: The purpose of this API is to add a member to a board in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"memberIds": "<string>",
"boardId": "<string>"
}
```
---
#### Delete Board Member
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/deletememberfromboard`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/deletememberfromboard?scopeID={scopeID}&memberId={memberId}&boardId={boardId}&api_token={api_token}
```
**Description**: The purpose of this API is to delete a board member in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | Network in which the board is in |
|`memberId` | string | Yes | ID of member to be removed |
|`boardId` | string | Yes | Board ID to remove the member from |
---
#### Updating a Board
**Method**: `PUT` | **LowCodeAPI Path**: `/pulse/api/updateboard`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/updateboard?api_token={api_token}
```
**Description**: The purpose of this API is to update a board's details in Zoho Connect network
**Request Body**:
```json
{
"scopeID": "<string>",
"boardId": "<string>"
}
```
---
#### Delete a Board
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/deleteboard`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/deleteboard?scopeID={scopeID}&boardId={boardId}&api_token={api_token}
```
**Description**: The purpose of this API is to delete a board in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the board is in |
|`boardId` | string | Yes | ID of the board to be deleted |
---
#### Create a Task
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/addtask`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/addtask?api_token={api_token}
```
**Description**: The purpose of this API is to create a task in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"title": "<string>",
"sectionId": "<string>",
"priority": "<string>",
"position": "<string>"
}
```
---
#### Add Section to a Board
**Method**: `PUT` | **LowCodeAPI Path**: `/pulse/api/addboardsection`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/addboardsection?api_token={api_token}
```
**Description**: The purpose of this API is to add a section to the board in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"name": "<string>",
"boardId": "<string>",
"position": "<string>"
}
```
---
#### Delete Board Section
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/deleteboardsection`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/deleteboardsection?scopeID={scopeID}§ionId={sectionId}&api_token={api_token}
```
**Description**: The purpose of this API is to delete a section from a board in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the Network the section is in |
|`sectionId` | string | Yes | ID of the section to be deleted |
---
#### Delete Task
**Method**: `DELETE` | **LowCodeAPI Path**: `/pulse/api/deletetask`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/deletetask?scopeID={scopeID}&taskId={taskId}&api_token={api_token}
```
**Description**: The purpose of this API is to delete a task
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the task is in |
|`taskId` | string | Yes | ID of the task to be deleted |
---
#### Get Board Section
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/boardsections`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/boardsections?scopeID={scopeID}&boardId={boardId}&api_token={api_token}
```
**Description**: The purpose of this API is to get sections from a board in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the board is in |
|`boardId` | string | Yes | ID of the board to get sections from |
---
#### Get my Boards
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/myboards`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/myboards?scopeID={scopeID}&boardsModifiedTime={boardsModifiedTime}&api_token={api_token}
```
**Description**: The purpose of this API is to get boards listed under My Boards in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network you want to get boards from |
|`boardsModifiedTime` | string | No | Fetch data from a specified time |
---
#### Update Board Section
**Method**: `PUT` | **LowCodeAPI Path**: `/pulse/api/updateboardsection`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/updateboardsection?api_token={api_token}
```
**Description**: The purpose of this API is to update a section in a board in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"sectionId": "<string>"
}
```
---
#### Update a Task
**Method**: `POST` | **LowCodeAPI Path**: `/pulse/api/updatetask`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/updatetask?api_token={api_token}
```
**Description**: The purpose of this API is to update a task in Zoho Connect
**Request Body**:
```json
{
"scopeID": "<string>",
"taskId": "<string>",
"title": "<string>",
"priority": "<string>"
}
```
---
### Category: User
#### Get User Activity
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/useractivities`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/useractivities?scopeID={scopeID}&userId={userId}&modifiedTime={modifiedTime}&api_token={api_token}
```
**Description**: The purpose of this API is to get a user's activity in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the user belongs to |
|`userId` | string | Yes | The user's ZU ID or user ID |
|`modifiedTime` | string | No | Fetch data till a specified time |
---
#### Get User Feed
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/v1/userstreams`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/v1/userstreams?scopeID={scopeID}&userId={userId}&partitionId={partitionId}&modifiedTime={modifiedTime}&limit={limit}&commentLimit ={commentLimit }&api_token={api_token}
```
**Description**: The purpose of this API is to get a user's feed in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the user belongs to |
|`userId` | string | Yes | The user's zu ID or user ID |
|`partitionId` | string | No | Group ID of the user |
|`modifiedTime` | string | No | Fetch data till a specific time |
|`limit` | string | No | Set a limit for the stream |
|`commentLimit ` | string | No | Set a limit on the number of comments |
---
#### Get User Groups
**Method**: `GET` | **LowCodeAPI Path**: `/pulse/api/usergroups`
**Full URL**:
```
https://api.lowcodeapi.com/zohoconnect/pulse/api/usergroups?scopeID={scopeID}&isRecentSort={isRecentSort}&api_token={api_token}
```
**Description**: The purpose of this API is to get user's groups in Zoho Connect
**Query Parameters**:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
|`scopeID` | string | Yes | ID of the network the user belongs to |
|`isRecentSort` | string | Yes | Set this as either true or false |
---
## Complete Endpoint Reference
For a complete list of all 61 endpoints, refer to:
- **OpenAPI Definition**: `https://backend.lowcodeapi.com/zohoconnect/definition`
- **Official Provider Documentation**: https://www.zoho.com/connect/api/intro.html