Updated on 2026-07-22 GMT+08:00

Updating a Message Notification Configuration

Function

This API is used to update a message notification configuration.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

AccessAnalyzer:notificationSetting:update

Write

notificationSetting *

-

-

-

URI

PUT /v5/notification-settings/{notification_setting_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

notification_setting_id

Yes

String

Definition:

Unique identifier of the message notification configuration.

You can call ListNotificationSettings API. This API returns a list of message notification configurations. Each configuration summary object in the list contains a unique id field, which is the message notification configuration ID.

Range:

1 to 36 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

mc_switch

Yes

Boolean

Definition:

Whether to enable message notifications.

Constraints:

N/A

Range:

N/A

Default Value:

N/A

smn_topic_urns

Yes

Array of strings

Definition:

URN list of SMN topics configured for message notifications.

Constraints:

N/A

Range:

The array length ranges from 0 to 3. The array element contains 1 to 1,500 characters.

Default Value:

N/A

Response Parameters

Status code: 200

OK

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Range:

N/A

error_msg

String

Definition:

Error message.

Range:

N/A

request_id

String

Definition:

Request ID.

Range:

N/A

encoded_authorization_message

String

Definition:

Authentication information.

Range:

N/A

Status code: 403

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Range:

N/A

error_msg

String

Definition:

Error message.

Range:

N/A

request_id

String

Definition:

Request ID.

Range:

N/A

encoded_authorization_message

String

Definition:

Authentication information.

Range:

N/A

Status code: 404

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Range:

N/A

error_msg

String

Definition:

Error message.

Range:

N/A

request_id

String

Definition:

Request ID.

Range:

N/A

encoded_authorization_message

String

Definition:

Authentication information.

Range:

N/A

Example Requests

Updating a message notification configuration

POST https://{hostname}/v5/notification-settings/{notification_setting_id}

{
  "mc_switch" : true,
  "smn_topic_urns" : [ "urn:smn:cn-north-7:******:test1" ]
}

Example Responses

None

Status Codes

Status Code

Description

200

OK

400

Bad request

403

Forbidden

404

NotFound

Error Codes

See Error Codes.