Skip to main content

PUT - Update notification details

Purpose

This API is used to update the notification details of a particular user.

Request URL

https://calendar.zoho.com/api/v1/notification

OAuth Scope

scope=ZohoCalendar.notification.ALL

(or)

scope=ZohoCalendar.notification.UPDATE

 

ALL - Full access to notifications

UPDATE - Update notifications

Parameters

  • notificationJSONobject, mandatory*

    Notification JSON can be passed to update the notification settings of a particular user using the following keys and values.

    Input JSON keys
    • emailformatstring, mandatory

      The format in which the reminder emails should be displayed. The values are:

      • 0 (html)
      • 1 (plain text)
    • remindernotifyboolean, mandatory

      Whether email reminders should be enabled or not. The values are:

      • true (on)
      • false (off)
    • agendanotifystring, mandatory

      This param is used to specify the frequency of agenda notifications. The values are:

      • -1 (off)
      • 0 (daily)
      • 1 (weekly)
    • notifyemailstring

      Email address to which the reminders/ notifications should be communicated to (Should be verifiable).

Sample Request

Copiedhttp://calendar.zoho.com/api/v1/notification

Sample Input

Copiedhttps://calendar.zoho.com/api/v1/notification?notification={
 "notifyemail": "user@domain.com",
 "emailformat": "0",
 "agendanotify": "-1",
 "remindernotify": true
}

Sample Response

Copied{
    "notification": [
        {
            "message": "Updated successfully."
        }
    ]
}