Enterprise Set Enterprise All Alert Recipients

Enterprise Set Enterprise All Alert Recipients

Specifies the recipients who should receive all alerts for the specified enterprise.

Privileges required:

UPDATE ENTERPRISE_ALERT

Request
URI
POST
https://{api_host}/portal/rest/enterprise/setEnterpriseAllAlertsRecipients
COPY
Request Body
{
    "enterpriseId": 0,
    "enterpriseUsers": [
        {
            "enterpriseUserId": 0,
            "enabled": false,
            "smsEnabled": false,
            "emailEnabled": false,
            "mobileEnabled": false
        }
    ],
    "smsEnabled": false,
    "smsList": [
        {
            "username": "string",
            "mobilePhone": "string",
            "email": "string"
        }
    ],
    "emailEnabled": false,
    "emailList": [
        "string"
    ],
    "mobileEnabled": false,
    "mobileList": [
        "string"
    ],
    "webhookEnabled": false,
    "webhookList": [
        {
            "url": "string",
            "expectedResponseCode": 0,
            "template": "string"
        }
    ]
}
integer
enterpriseId
Optional

enterpriseId

array of object
enterpriseUsers
Optional

enterpriseUsers

boolean
smsEnabled
Optional

smsEnabled

array of object
smsList
Optional

smsList

boolean
emailEnabled
Optional

emailEnabled

array of string
emailList
Optional

emailList

boolean
mobileEnabled
Optional

mobileEnabled

array of string
mobileList
Optional

mobileList

boolean
webhookEnabled
Optional

webhookEnabled

array of object
webhookList
Optional

webhookList

Responses
200

Request was successfully processed

This response body class contains all of the following: Inlineenterprise_set_enterprise_all_alert_recipients_result0 
{
    "emailEnabled": false,
    "emailList": [
        "string"
    ],
    "enterpriseUsers": [
        {
            "email": "string",
            "emailEnabled": 0,
            "enabled": 0,
            "enterpriseUserId": 0,
            "mobileEnabled": 0,
            "mobilePhone": "string",
            "smsEnabled": 0,
            "username": "string"
        }
    ],
    "mobileEnabled": false,
    "mobileList": [
        "string"
    ],
    "smsEnabled": false,
    "smsList": [
        "string"
    ],
    "snmpEnabled": false,
    "snmpList": [
        "string"
    ],
    "webhookEnabled": false
}

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/portal/rest/enterprise/setEnterpriseAllAlertsRecipients
On This Page
All Operations
POST
Enterprise Get Enterprise Alert Definitions
POST
Enterprise Delete Enterprise
POST
Enterprise Delete Enterprise Gateway Records
POST
Enterprise Delete Enterprise Network Allocation
POST
Enterprise Delete Enterprise Network Segment
POST
Enterprise Delete Enterprise Service
POST
Enterprise Get Enterprise Addresses
POST
Enterprise Get Enterprise Alert Configurations
POST
Enterprise Get Enterprise Alerts
POST
Enterprise Get Enterprise All Alert Recipients
POST
Enterprise Get Enterprise Configurations
POST
Enterprise Get Enterprise Network Allocations
POST
Enterprise Get Enterprise Network Segments
POST
Enterprise Get Enterprise Operator Configuration
POST
Enterprise Get Enterprise Route Configuration
POST
Enterprise Get Enterprise Route Table
POST
Enterprise Get Enterprise Services
POST
Enterprise Get Enterprises Missinggateway
POST
Enterprise Insert Enterprise Service
POST
Enterprise Insert Or Update Enterprise Alert Configurations
POST
Enterprise Set Enterprise All Alert Recipients
POST
Enterprise Set Enterprise Operator Configuration
POST
Enterprise Log Export Test Connectivity
POST
Enterprise Update Enterprise Route
POST
Enterprise Update Enterprise Route Configuration
POST
Enterprise Update Enterprise Service
POST
Get Functional Roles By Enterprise