To purpose of this API is to create a new announcement 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 (Required) | Network in which the announcement is to be posted. You can get this from the network list. | Required |
| partitionID (Required) | It can be either be the Group or Company wall. The id can be obtained from the partition API. | Required |
| streamContent (Required) | Add your announcement message. Maximum characters allowed is 10000. | Required |
| streamTitle (Required) | Title for your announcement. Maximum characters allowed is 300. | Required |
| streamType (Required) | Set this as ANNOUNCEMENT. | Required |
| fileIds (Optional) | Multiple file ids should be separated by a comma. Upload files using the upload files API, and then use the file IDs. You can add up to 10 files to an announcement. | Optional |
| isAnnouncement (Required) | Set this as true. | Required |
| expiryYear(Optional) | Expiry year for the announcement. eg) 2019 | Optional |
| expiryMonth(Optional) | Expiry month for the announcement. eg) 11 | Optional |
| expiryDate(Optional) | Expiry date for the announcement. eg) 1 | Optional |
Sample URL
Copiedhttps://connect.zoho.com/pulse/api/v2/addStream?scopeID=929000000015001&partitionID=929000000295001&streamTitle=New+Announcement&streamContent=Testing+of+new+post&streamType=ANNOUNCEMENT&expiryYear=2018&expiryMonth=7&expiryDate=1Sample Response
Copied{
"addStream": {
"stream": {
"id": "929000000935016",
"title": "New Announcement",
"bestCommentId": "0",
"streamUrl": "new-announcement",
"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 an announcement in *^$@_PARTITION_*^$@."
},
"type": "ANNOUNCEMENT",
"content": "Testing of new post",
"time": "1528193604821",
"streamModifiedTime": "1528193604821",
"formatedTime": "03:43 PM",
"lastActivityTime": "1528193604821",
"canHide": "true",
"canEdit": "true",
"canDelete": "true",
"canLock": "true",
"canFollow": "true",
"canMove": "true",
"comments": [],
"url": "https://connect.zoho.com/portal/zillum/stream/929000000935016",
"streamMentionData": [
{
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"type": "C",
"emailId": "patriciab@zillum.com",
"role": "MEMBER"
}
]
}
}
}Show full
Show less