Web API Reference Guide > Available API Methods > Notification Center Methods > The updateNotification Method

The updateNotification Method

Update notification properties.

Version: 1.3

Required Permissions: Full

HTTP method: POST

Supported by Editions: All

Request Parameters:  

Parameter

 Type

Required

Description

type

String

Yes

One of types.

repeat

Integer

No

How long the notification should be hidden from user (in minutes).

Expected Response Code: 200 OK. For more information see Response Format.

Response Format: notificationsList

Possible Action Specific Error Codes: This method has no action-specific error codes.

Example

Usage Example

Request

POST /ZendServer/Api/updateNotificationtype=phpRestart&repeat=5

Response

<?xml version="1.0" encoding="UTF-8"?>

<zendServerAPIResponse xmlns="http://www.zend.com/server/api/1.3">

<requestData>

<apiKeyName><![CDATA[Admin]]></apiKeyName>

<method>updateNotifications</method>

</requestData>

<responseData>

<notifications>

<notification>

<id>3</id>

<severity><![CDATA[Warning]]></severity>

<creationTime></creationTime>

<type>1</type>

<name>phpRestart</name>

<repeats>20</repeats>

<title><![CDATA[Restart required]]</title>

<description><![CDATA[...]]</description>

<url><![CDATA[...]]</url>

</notification>

</notifications>

</responseData>

</zendServerAPIResponse>

 

Read Also

  Available API Methods    
  Notification Center Methods