The purpose of this API is to create a private 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
Name | Description | Required |
scopeID | Network in which the stream is to be posted. Can be obtained from the network list API. | Required |
partitionID | It can be either group or user's wall. The id can be obtained from the partition API. | Optional |
streamContent | Private message to be posted. | Required |
streamTitle | Title for the post. | Optional |
linkURL | Link URL to be shared. | Optional |
linkDesc | Description for the link. | Optional |
linkTitle | Title of the link URL. | Optional |
linkImage (Optional) | Image URL to be shared. | Optional |
fileIds (Optional) | Multiple file IDs should be separated by a comma. Upload files using upload files API, and then use the file IDs. You can add up to 10 files to a post. | Optional |
isPrivate (Required) | Se this as true. | Required |
streamMembers (Optional) | Add the user IDs of members you want to share this message with. Separate multiple IDs using a comma. | Optional |
streamGroups (Optional) | Add the IDs of groups you want to share this message with. Multiple Group IDs should be separated by a comma. | Optional |
Creating a private post and adding members to it:
Sample URL
Copiedhttps://connect.zoho.com/pulse/api/v2/addStream?scopeID=929000000015001&isPrivate=true&streamContent=Samplecontent&streamMembers=2060758,2060751
Sample Response
Copied{
"addStream": {
"stream": {
"id": "929000000855608",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
},
"allowFooter": "true",
"isApproved": "true",
"isSpam": "false",
"canAddTask": "true",
"isPrivate": "true",
"sharedMembers": [],
"memberListCount": "0",
"pvtMemberList": ",,",
"reason": {
"items": {
"*^$@_USERNAME_*^$@_2060758": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
}
},
"msg": "*^$@_USERNAME_*^$@_2060758 has privately shared this post."
},
"type": "STATUS",
"content": [
{
"text": "Samplecontent"
}
],
"time": "1521524839059",
"streamModifiedTime": "1521524839059",
"formatedTime": "06:47 PM",
"privateTitleMsg": "<a class=\"PosterName\" purpose=\"authorNameTemplate\" onclick=\"return false;\" href=\"/portal/zillum/profile/2060758\" userId=\"2060758\">Patricia Boyle</a><span> has privately shared this post.</span> <label class=\"Pmember sharedMemCont\" purpose=\"sharedMemCont\"><i class=\"ci-circle-plus\" purpose=\"addMemberIcon\"></i></label>",
"lastActivityTime": "1521524839059",
"canHide": "true",
"canEdit": "true",
"canDelete": "true",
"canLock": "true",
"canFollow": "true",
"comments": [],
"url": "https://connect.zoho.com/portal/zillum/stream/929000000855608",
"streamMentionData": [
{
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"type": "C",
"emailId": "patriciab@zillum.com",
"role": "MEMBER"
}
]
}
}
}
Show full
Show less
Creating a private post and adding links to it:
Sample URL
Copiedhttps://connect.zoho.com/pulse/api/v2/addStream?scopeID=929000000015001&isPrivate=true&streamContent=Shows&linkDesc=sivakarthikeyan+comedy+shows&linkImage=https://i.ytimg.com/vi/tiOCrlrpbNo/hqdefault.jpg&linkTitle=sivakarthikeyan+comedy+shows+-+YouTube&linkURL=https://www.youtube.com/watch?v=tiOCrlrpbNo&videoUrl=https://www.youtube.com/watch?v=tiOCrlrpbNo
Sample Response
Copied{
"addStream": {
"stream": {
"id": "929000000855617",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
},
"allowFooter": "true",
"isApproved": "true",
"isSpam": "false",
"canAddTask": "true",
"link": {
"linkurl": "https://www.youtube.com/watch?v=tiOCrlrpbNo",
"title": "sivakarthikeyan comedy shows - YouTube",
"desc": "sivakarthikeyan comedy shows",
"fileId": "3158684000000238001",
"linkInfoId": "929000000855624",
"imgWidth": "480",
"imgHeight": "360",
"videoId": "tiOCrlrpbNo",
"videoType": "YOUTUBE",
"embedUrl": ""
},
"isPrivate": "true",
"sharedMembers": [],
"memberListCount": "0",
"pvtMemberList": ",,",
"reason": {
"items": {
"*^$@_USERNAME_*^$@_2060758": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
}
},
"msg": "*^$@_USERNAME_*^$@_2060758 has shared a link."
},
"type": "LINK",
"content": [
{
"text": "Shows"
}
],
"time": "1521524899147",
"streamModifiedTime": "1521524899147",
"formatedTime": "06:48 PM",
"privateTitleMsg": "<a class=\"PosterName\" purpose=\"authorNameTemplate\" onclick=\"return false;\" href=\"/portal/zillum/profile/2060758\" userId=\"2060758\">Patricia Boyle</a><span> has privately shared this post.</span> <label class=\"Pmember sharedMemCont\" purpose=\"sharedMemCont\"><i class=\"ci-circle-plus\" purpose=\"addMemberIcon\"></i></label>",
"lastActivityTime": "1521524899147",
"canHide": "true",
"canEdit": "true",
"canDelete": "true",
"canLock": "true",
"canFollow": "true",
"comments": [],
"url": "https://connect.zoho.com/portal/zillum/stream/929000000855617",
"streamMentionData": [
{
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"type": "C",
"emailId": "patriciab@zillum.com",
"role": "MEMBER"
}
]
}
}
}
Show full
Show less