Update Announcements API

To edit an already posted announcement

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Request Parameters:

*idID of the announcement to be updated
*subjectSubject of the announcement
*messageMessage to be given in the announcement
expiryDateExpiry date of the announcement given in specified format ; -1 denotes no expiration for the announcement
locationLocation which receives the announcement/ If param not given then all locations receive the announcement
emailListEmail IDs to send notification (multiple emails can be separated with comma)/ if param not given then no mail notifications will be sent
notifyif true is given - mail notification will be sent to the people in the given location/ if location is not given, the mail notification will be sent to all locations; if false is given - no email notification is sent
isStickyif true is given then it is updated as a sticky announcement; if false is given then it is updated as an announcement
isCommentDisableif 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/updateAnnouncement?subject=Wellness Program!&message=Enjoy a week-long wellness program at all our office locations.&emailList=c.spalding@zylker.com&notify=true&isSticky=true&isCommentDisable=true&
id=3610330000035 69704

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Sample Response

XMLJson
Copiedresponse uri="/api/announcement/updateAnnouncement">
    <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>
            <announcementId>3000000183025</announcementId>
            <publishDate>1543211455782</publishDate>
            <isActive>true</isActive>
            <notifyOthersEmailIds>c.spalding@zylker.com,</notifyOthersEmailIds>
            <isSticky>false</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,
                "announcementId": "3000000183025",
                "publishDate": "1543211455782",
                "isActive": true,
                "notifyOthersEmailIds": "c.spalding@zylker.com,",
                "isSticky": false
            }
        },
        "message": "Success",
         "uri": "/api/announcement/updateAnnouncement", 
        "status": 0
    }
}

Error Response

XMLJson
Copied<response uri="/api/announcement/updateAnnouncement">
    <status>1</status>
    <message>We have encountered an exception</message>
    <errors>
        <resultData></resultData>
    </errors>
</response>
Copied{
    "response": {
        "message": "We have encountered an exception",
      "uri": "/api/announcement/updateAnnouncement",  
      "errors": {
            "resultData": {}
        },
        "status": 1
    }
}