Jump to

• Request
• Response
• Examples

Set Email Notification Configuration

put

/documents/api/1.2/config/notification/email

Update email notification configuration for this service instance. To update this configuration, you must log in as an administrator.

Request

Supported Media Types

• application/json
• application/xml

Body ()

The request body defines the details of setting email notification in this service instance.

Root Schema : SetNotificationEmailRequest

Type: object

Set email notification configuration request.

Show Source

• disableEmailNotifications(optional): string
  Set to true if email notification needs to be disabled. Set to false otherwise.

{
    "description":"Set email notification configuration request.",
    "properties":{
        "disableEmailNotifications":{
            "type":"string",
            "description":"Set to <code>true</code> if email notification needs to be disabled. Set to <code>false</code> otherwise."
        }
    }
}

Example Request (application/json)

{
    "disableEmailNotifications":"true"
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : SetNotificationEmailResponse

Type: object

Set email notification configuration response.

Show Source

• errorCode(optional): number
  An error code of zero (0) indicates no errors.
• type(optional): string
  Item type config.

{
    "description":"Set email notification configuration response.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>config</code>."
        }
    }
}

Example Response (application/json)

{
    "errorCode":"0",
    "type":"config"
}

400 Response

Input value is invalid or value requested did not change.

403 Response

Forbidden if the user does not have Admin role.

Back to Top

Examples

The following example disables email notification for this service instance.

PUT .../config/notification/email

Request Header

None.

Request Body

{
   "disableEmailNotifications": "true"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
   "errorCode":"0",
   "type":"config"

Back to Top