The purpose of this API is to update feed or poll preferences in Zoho Connect.
| Request URL: | https://connect.zoho.com/pulse/api/updateStream |
OAuth Scope: | zohopulse.feedlist.UPDATE |
Request Method: | PUT |
| Mandatory Header: | Header name: Authorization Header Value: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52 |
Parameters
| Name | Description | Required |
| streamId | ID of the stream to be updated. | Required |
| scopeID | Network in which the stream to be updated is in. You can get this from the Network list API. | Required |
| streamContent | Content for the stream. | Required |
| streamTitle | Title for the stream. | Optional |
| linkURL | Link URL to be shared. | Optional |
| linkDesc | Description for the link. | Optional |
| linkTitle | Title for the link URL. | Optional |
| linkImage | URL of the image to be shared. | Optional |
| fileIds | Multiple file IDs should be separated by a comma. Upload files using uploadFiles API and then return the fields. You can add up to 10 files to a stream. | Optional |
| reorderFileIds | Reorder the file IDs and separate multiple IDs by a comma. | Optional |
| videoUrl | Video URL of Youtube/Docs. | Optional |
| isZohoDocsUrl | If video URL is a Zoho Docs file, set this as true. | Optional |
| resourceType | Zoho Docs file type | Optional |
| textOptions | Provide options for the poll. Separate multiple options with a comma. | Optional |
| removedOptionIds | Reorder the poll option IDs and separate multiple IDs with a comma. | Optional |
| imageIds | Image options for the poll should be separated by a comma. Upload files using the uploadFiles API and then return the fields. You can add up to 10 poll options. | Optional |
| textOption | Text Options for the Poll. | Optional |
| voteDisplayType | Add the members' ZU IDs separated by commas. | Optional |
| canEditVote | Set this as True to enable editing of votes and False to disable edit. | Optional |
| canDeclareResult | Set this as True to declare results and False if you don't want them declared. | Optional |
| allowMultiple | Set this as True if you'd like to allow members to vote for multiple options and False if you want to disable voting for multiple options. | Optional |
| optionOrders | Order of the poll options, separated by a comma. | Optional |
| endYear | Year for the poll to expire. ex) 2019 | Optional |
| endMonth | Month for the poll to expire. ex) 08 | Optional |
| endDate | Day for the poll to expire. ex) 21 | Optional |
| endHour | Hour for the poll to expire. This should be in the 24 hour format. ex) 20 | Optional |
| endMin | Minute for the poll to expire. ex) 18 | Optional |
Update Feed Content
Sample URL
Copiedhttps://connect.zoho.com/pulse/api/updateStream?scopeID=929000000015001&streamId=929000000855628&streamContent=Content+updatedSample Response
Copied{
"updateStream": {
"stream": {
"id": "929000000855628",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true",
"type": "C"
},
"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": "Content updated"
}
],
"time": "1521525017127",
"streamModifiedTime": "1521525017127",
"formatedTime": "06:50 PM",
"lastActivityTime": "1521525076892",
"viewCount": "1",
"canHide": "true",
"canEdit": "true",
"canDelete": "true",
"canLock": "true",
"canFollow": "true",
"canMove": "true",
"comments": [],
"url": "https://connect.zoho.com/portal/zillum/stream/929000000855628",
"streamMentionData": [
{
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"type": "C",
"emailId": "patriciab@zillum.com",
"role": "MEMBER"
}
]
}
}
}Show full
Show less
Updating poll preference options
Sample URL
Copiedhttps://connect.zoho.com/pulse/api/updateStream?scopeID=929000000015001&streamId=929000000855639&streamContent=pollQuestion&allowMultiple=true&voteDisplayType=0&endDate=20&endHour=13&endMinute=0&endMonth=3&endYear=2018Sample Response
Copied{
"updateStream": {
"stream": {
"id": "929000000855639",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true",
"type": "C"
},
"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 started a poll in *^$@_PARTITION_*^$@."
},
"type": "POLL",
"polls": {
"voteDisplayType": "0",
"allowmultiple": "true",
"canShowResult": "true",
"isVoted": "false",
"options": [
{
"id": "929000000855646",
"option": "Option1",
"canDelete": "true"
},
{
"id": "929000000855648",
"option": "Option2",
"canDelete": "true"
}
]
},
"canAddPollOption": "true",
"content": [
{
"text": "pollQuestion"
}
],
"time": "1521525195934",
"streamModifiedTime": "1521525195934",
"formatedTime": "06:53 PM",
"lastActivityTime": "1521525290081",
"viewCount": "3",
"canHide": "true",
"canEdit": "true",
"canDelete": "true",
"canLock": "true",
"canEditVote": "true",
"canFollow": "true",
"canMove": "true",
"comments": [],
"url": "https://connect.zoho.com/portal/zillum/stream/929000000855639",
"streamMentionData": [
{
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"type": "C",
"emailId": "patriciab@zillum.com",
"role": "MEMBER"
}
]
}
}
}Show full
Show less