Help Center/ Simple Message Notification/ API Reference/ APIs/ Message Filter Policies of Subscribers/ Updating Message Filter Policies of Subscribers
Updated on 2025-08-22 GMT+08:00
View PDF

Updating Message Filter Policies of Subscribers

Function

This API is used to update the message filter policies of subscribers.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/notifications/subscriptions/filter_polices

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.For details about how to obtain the project ID, see Obtaining the Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies a user token.

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

polices

Yes

Array of polices objects

Specifies subscriber policies to be processed in batches.
Table 4 polices

Parameter

Mandatory

Type

Description

subscription_urn

Yes

String

Specifies the resource identifier of the subscriber, which is unique. To obtain the resource identifier, see Querying Subscribers.

filter_polices

Yes

Array of SubscriptionsFilterPolicy objects

Specifies the message filter policies of a subscriber. The policy name must be unique.
Table 5 SubscriptionsFilterPolicy

Parameter

Mandatory

Type

Description

name

Yes

String

Specifies the filter policy name.

name can contain 1 to 32 characters, including lowercase letters, digits, and underscores (). name cannot start or end with an underscore, nor contain consecutive underscores. name cannot start with **smn**.

string_equals

Yes

Array of strings

Specifies the string array for exact match. An array can contain 1 to 10 strings. The array content must be unique. The string cannot be null or an empty string "". A string can contain 1 to 32 characters, including letters, digits, and underscores (_).

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the unique request ID.

batch_result

Array of BatchResult objects

Specifies the batch processing result.
Table 7 BatchResult

Parameter

Type

Description

code

String

Specifies the returned code.

message

String

Specifies the code message.

subscription_urn

String

Specifies the subscriber URN.

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID, which is unique.

code

String

Specifies the error code.

message

String

Describes the error message.

Example Requests

Updating message filter policies of a subscriber

PUT https://{SMN_Endpoint}/v2/{project_id}/notifications/subscriptions/filter_polices

{
  "polices" : [ {
    "subscription_urn" : "urn:smn:regionId:762bdb3251034f268af0e395c53ea09b:test_topic_v1:2e778e84408e44058e6cbc6d3c377837",
    "filter_polices" : [ {
      "name" : "alarm",
      "string_equals" : [ "os", "process" ]
    }, {
      "name" : "service",
      "string_equals" : [ "api", "db" ]
    } ]
  } ]
}

Example Responses

Status code: 200

OK

{
  "request_id" : "be368401641b406d8c28a79915ba3589",
  "batch_result" : [ {
    "code" : "SMN.00011027",
    "message" : "Parameter: subscription_urn is invalid.",
    "subscription_urn" : "urn:smn:regionId:98386b0630aa41d990d4729497fcd7ba:test:90b22be1efab4cd6924703c5b228e59f"
  }, {
    "code" : "SMN.00011027",
    "message" : "Parameter: subscription_urn is invalid.",
    "subscription_urn" : "urn:smn:regionId:98386b0630aa41d990d4729497fcd7ba:test:c872b769e60d45f682f1da44eb4dbee3"
  } ]
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Unauthorized

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.