Skip to main content

Enable or Disable Announcements API

To enable or disable an announcement. Disabling an announcement will retain related data and so the announcement can be enabled when required.

Header:

Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Request Parameters:

*idID of the announcement to be enabled/disabled. If announcement is currently enabled, then if param is given then the announcement is disabled and vice versa.

 Threshold Limit:  20 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/api/announcement/enableDisableAnnouncement? id=3000000183011

Header

CopiedAuthorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxx9be93.9b8xxxxxxf

Success Response

Copied<response uri="/api/announcement/enableDisableAnnouncement">
    <status>0</status>
    <message>Success</message>
    <result>
        <resultData>
            <status>0</status>
        </resultData>
    </result>
</response>
Copied{
    "response": {
        "result": {
            "resultData": {
                "status": 1
            }
        },
        "message": "Success",
        "uri": "/api/announcement/enableDisableAnnouncement",  
        "status": 0
    }
}

Show full

Show less

Error Response

Copied<response uri="/api/announcement/enableDisableAnnouncement">
    <status>1</status>
    <message>You are not permitted to access announcements;</message>
    <errors>
        <resultData></resultData>
    </errors>
</response>
Copied{
    "response": {
        "result": {
            "code": "Permission Denied",
            "resultData": {}
        },
        "message": "You are not permitted to access announcements;",
        "uri": "/api/announcement/enableDisableAnnouncement",  
        "status": 0
    }
}

Show full

Show less