Add Announcement
To post an announcement using API
Header:
Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Request Parameters:
*subject | Subject of the announcement to be added |
*message | Message to be given in the announcement |
expiryDate | Expiry date of the Announcement given in specified format ; -1 denotes no expiration for the announcement |
location | Location which receives the announcement/ If param not given then all locations receive the announcement |
emailList | Email IDs to send notification (multiple emails can be separated with comma)/ if param not given then no mail notifications will be sent |
notify | if true is given - mail notification will be sent to the people in the given locations/ if locations is not given, the mail notification will be sent to all locations; if false is given - no email notification is sent |
isSticky | if true is given then it is added as a sticky announcement; if false is given then it is added as an announcement |
isCommentDisable | if true is given then adding comment is disabled for the user; if false is given then adding comment is enabled for the user. |
Threshold Limit: 10 requests | Lock period: 5 minutes
Threshold Limit - Number of API calls allowed within a minute.
Lock Period - Wait time before consecutive API requests.
Sample Request
Copiedhttps://people.zoho.com/people/api/announcement/addAnnouncement?subject=Wellness Program!&message=Enjoy a week-long wellness program at all our office locations.&emailList=c.spalding@zylker.com¬ify=true&isSticky=true&&isCommentDisable=true
Header
CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf
Sample Response
Copied<response uri="/api/announcement/addAnnouncement">
<status>0</status>
<message>Success</message>
<result>
<resultData>
<owner>3000000013255</owner>
<messageText>Enjoy a week-long wellness program at all our office locations.</messageText>
<emailList>c.spalding@zylker.com,</emailList>
<subject>Wellness Program!</subject>
<isNotify>1</isNotify>
<isCommentDisable>1</isCommentDisable>
<publishDate>1543211455782</publishDate>
<announcementId>3000000183025</announcementId>
<isActive>true</isActive>
<notifyOthersEmailIds>c.spalding@zylker.com,</notifyOthersEmailIds>
<isSticky>true</isSticky>
</resultData>
</result>
</response>
Copied{
"response": {
"result": {
"resultData": {
"owner": "3000000013255",
"messageText": "Enjoy a week-long wellness program at all our office locations.",
"emailList": "c.spalding@zylker.com,",
"subject": "Wellness Program!",
"isNotify": 1,
"isCommentDisable": 1,
"publishDate": "1543211440496",
"announcementId": "3000000183023",
"isActive": true,
"notifyOthersEmailIds": "c.spalding@zylker.com,",
"isSticky": true
}
},
"message": "Success", "uri": "/api/announcement/addAnnouncement",
"status": 0
}
}