Workplace from Meta is being discontinued – seamlessly migrate to Zoho Connect today. Learn More

Skip to product menu
Zoho connect
Skip to main content
Zoho connect

The purpose of this API is to start a post in Zoho Connect.

Request URL:

https://connect.zoho.com/pulse/api/v2/addStream

OAuth Scope:

zohopulse.feedList.CREATE

Request Method:

POST

Mandatory Header:Header name: Authorization
Header Value: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52

Parameters

NameDescriptionRequired
scopeIDNetwork in which the post is to be shared. You can get the ID from the network list API.Required
partitionIDIt can either be the Group or Company wall. You can get the ID from the partition API.Optional
streamContent

Content for the post: Maximum characters allowed is 10000.

Mentions in a post:

We handle three types of @mentions: org-group mentions, user mentions, and group mentions.

  1. <user:mention>userId:username</user:mention> (user mention)
  2. <group:mention>partitionId:partitionName</group:mention>
  3. <orggroup:mention>zgid:group name</orggroup:mention>

 

Format a post:

  1. Bold = <b>Content+here</b>
  2. Italic = <i>Content+here</i>
  3. Underline = <u>Content+here</u>
  4. OrderedList = <ol><li>Content+here</li><li>Content+here</li></ol>
  5. UnorderedList = <ul><li>Content+here</li><li>Content+here</li></ul>
  6. Blockquote = <blockquote>Content+here</blockquote>
  7. Highlight = <code>Content+here</code>
  8. Strikethrough = <strike>Content+here</strike>
Required
streamTitleTitle for the postOptional
linkURLURL of link to be shared in the postOptional
linkDescDescription for the linkOptional
linkTitleTitle for the link URLOptional
linkImageURL of image to be shared in the postOptional
fileIdsFile IDs should be seperated by comma. Upload files using upload Files api and use the file Ids; you can add up to 10 files in a post.Optional

 

Mentioning user in a post:

Sample URL

Copiedhttps://connect.zoho.com/pulse/api/v2/addStream?scopeID=929000000015001&partitionID=929000000295001&streamContent=Sample+content

Sample Response

Copied{
  "addStream": {
    "stream": {
      "id": "929000000855599",
      "userDetails": {
        "zuid": "2060758",
        "id": "2060758",
        "name": "Patricia Boyle",
        "canFollow": "true"
      },
      "partition": {
        "id": "929000000295001",
        "name": "Engineering",
        "partitionUrl": "engineering",
        "url": "engineering",
        "isPrivate": "true",
        "status": "ACTIVE",
        "isAdmin": "true",
        "type": "GROUP",
        "typeOrd": "2",
        "isUserFollow": "false"
      },
      "allowFooter": "true",
      "isApproved": "true",
      "isSpam": "false",
      "canAddTask": "true",
      "reason": {
        "items": {
          "*^$@_PARTITION_*^$@": {
            "id": "929000000295001",
            "name": "Engineering",
            "partitionUrl": "engineering",
            "url": "engineering",
            "isPrivate": "true",
            "status": "ACTIVE",
            "isAdmin": "true",
            "type": "GROUP",
            "typeOrd": "2",
            "isUserFollow": "false"
          },
          "*^$@_USERNAME_*^$@_2060758": {
            "zuid": "2060758",
            "id": "2060758",
            "name": "Patricia Boyle",
            "canFollow": "true"
          }
        },
        "msg": "*^$@_USERNAME_*^$@_2060758 has posted in *^$@_PARTITION_*^$@."
      },
      "type": "STATUS",
      "content": [
        {
          "text": "Sample content"
        }
      ],
      "time": "1521524763992",
      "streamModifiedTime": "1521524763992",
      "formatedTime": "06:46 PM",
      "lastActivityTime": "1521524763992",
      "canHide": "true",
      "canEdit": "true",
      "canDelete": "true",
      "canLock": "true",
      "canFollow": "true",
      "canMove": "true",
      "comments": [],
      "url": "https://connect.zoho.com/portal/zillum/stream/929000000855599",
      "streamMentionData": [
        {
          "zuid": "2060758",
          "id": "2060758",
          "name": "Patricia Boyle",
          "type": "C",
          "emailId": "patriciab@zillum.com",
          "role": "MEMBER"
        }
      ]
    }
  }
}

Show full

Show less

Mentioning user in a post:

Sample URL

Copiedhttps://connect.zoho.com/pulse/api/v2/addStream?scopeID=929000000015001&partitionID=929000000295001&streamTitle=New+Post&streamContent=Testing+of+new+post+%3Cuser:mention%3E2060557:Eduardo+Vargas%3C/user:mention%3ESome

Sample Response

Copied{
  "addStream": {
    "stream": {
      "id": "929000000935122",
      "title": "New Post",
      "bestCommentId": "0",
      "streamUrl": "new-post",
      "userDetails": {
        "zuid": "2060758",
        "id": "2060758",
        "name": "Patricia Boyle",
        "canFollow": "true"
      },
      "partition": {
        "id": "929000000295001",
        "name": "Engineering",
        "partitionUrl": "engineering",
        "url": "engineering",
        "isPrivate": "true",
        "status": "ACTIVE",
        "isAdmin": "true",
        "type": "GROUP",
        "typeOrd": "2",
        "isUserFollow": "false"
      },
      "allowFooter": "true",
      "isApproved": "true",
      "isSpam": "false",
      "canAddTask": "true",
      "reason": {
        "items": {
          "*^$@_PARTITION_*^$@": {
            "id": "929000000295001",
            "name": "Engineering",
            "partitionUrl": "engineering",
            "url": "engineering",
            "isPrivate": "true",
            "status": "ACTIVE",
            "isAdmin": "true",
            "type": "GROUP",
            "typeOrd": "2",
            "isUserFollow": "false"
          },
          "*^$@_USERNAME_*^$@_2060758": {
            "zuid": "2060758",
            "id": "2060758",
            "name": "Patricia Boyle",
            "canFollow": "true"
          }
        },
        "msg": "*^$@_USERNAME_*^$@_2060758 has posted in *^$@_PARTITION_*^$@."
      },
      "type": "STATUS",
      "content": "Testing of new post <a href='#profile/2060557' memberId='2060557' purpose='getUserProfile' onclick='return false;'>@Eduardo Vargas</a>",
      "time": "1528206350707",
      "streamModifiedTime": "1528206350707",
      "formatedTime": "07:15 PM",
      "lastActivityTime": "1528206350707",
      "canHide": "true",
      "canEdit": "true",
      "canDelete": "true",
      "canLock": "true",
      "canFollow": "true",
      "canMove": "true",
      "comments": [],
      "url": "https://connect.zoho.com/portal/zillum/stream/929000000935122",
      "streamMentionData": [
        {
          "zuid": "2060557",
          "id": "2060557",
          "name": "Eduardo Vargas",
          "canFollow": "true",
          "type": "C",
          "emailId": "eduardov@zillum.com",
          "role": "MEMBER"
        },
        {
          "zuid": "2060758",
          "id": "2060758",
          "name": "Patricia Boyle",
          "type": "C",
          "emailId": "patriciab@zillum.com",
          "role": "MEMBER"
        }
      ]
    }
  }
}

Show full

Show less

Formatting in a post:

Sample URL

Copiedhttps://connect.zoho.com/pulse/api/v2/addStream?scopeID=929000000015001&partitionID=929000000295001&streamContent=%3Cb%3ESample+content%3C/b%3E%3Ci%3Efor+testing%3C/i%3E%3Col%3E%3Cli%3ERandom+access%3C/li%3E%3Cli%3EFirst+access%3C/li%3E%3C/ol%3Etest

Sample Response

Copied{
  "addStream": {
    "stream": {
      "id": "929000000936186",
      "userDetails": {
        "zuid": "2060758",
        "id": "2060758",
        "name": "Patricia Boyle",
        "canFollow": "true"
      },
      "partition": {
        "id": "929000000295001",
        "name": "Engineering",
        "partitionUrl": "engineering",
        "url": "engineering",
        "isPrivate": "true",
        "status": "ACTIVE",
        "isAdmin": "true",
        "type": "GROUP",
        "typeOrd": "2",
        "isUserFollow": "false"
      },
      "allowFooter": "true",
      "isApproved": "true",
      "isSpam": "false",
      "canAddTask": "true",
      "reason": {
        "items": {
          "*^$@_PARTITION_*^$@": {
            "id": "929000000295001",
            "name": "Engineering",
            "partitionUrl": "engineering",
            "url": "engineering",
            "isPrivate": "true",
            "status": "ACTIVE",
            "isAdmin": "true",
            "type": "GROUP",
            "typeOrd": "2",
            "isUserFollow": "false"
          },
          "*^$@_USERNAME_*^$@_2060758": {
            "zuid": "2060758",
            "id": "2060758",
            "name": "Patricia Boyle",
            "canFollow": "true"
          }
        },
        "msg": "*^$@_USERNAME_*^$@_2060758 has posted in *^$@_PARTITION_*^$@."
      },
      "type": "STATUS",
      "content": [
        {
          "b": "start"
        },
        {
          "text": "Sample content"
        },
        {
          "b": "end"
        },
        {
          "i": "start"
        },
        {
          "text": "for testing"
        },
        {
          "i": "end"
        },
        {
          "ol": "start"
        },
        {
          "text": "Random access"
        },
        {
          "ol": "end"
        },
        {
          "ol": "start"
        },
        {
          "text": "First access"
        },
        {
          "ol": "end"
        }
      ],
      "time": "1528266317889",
      "streamModifiedTime": "1528266317889",
      "formatedTime": "11:55 AM",
      "lastActivityTime": "1528266317889",
      "canHide": "true",
      "canEdit": "true",
      "canDelete": "true",
      "canLock": "true",
      "canFollow": "true",
      "canMove": "true",
      "comments": [],
      "url": "https://connect.zoho.com/portal/zillum/stream/929000000936186",
      "streamMentionData": [
        {
          "zuid": "2060758",
          "id": "2060758",
          "name": "Patricia Boyle",
          "type": "C",
          "emailId": "patriciab@zillum.com",
          "role": "MEMBER"
        }
      ]
    }
  }
}

Show full

Show less

© 2025, Zoho Corporation Pvt. Ltd. All Rights Reserved.

 
 

Next Steps