Delete Message Rules¶

Delete message rules.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.2/message-service/rule/delete

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
orgId	Query	Required	String	OU ID. How to get orgId >>

Request Parameters (Header)¶

Name

Required/Optional

Data Type

Description

Authorization

Optional

String

The access token generated after the user logs in and selects the OU, represented by Bearer Token, is in the form of Bearer {your token}. You can call the Log In or Refresh Access Token API to obtain the access token.

If this parameter is not specified, the operator of this deletion will be considered as the application.
If this parameter is specified, the operator of this deletion will be considered as the user which the access token belongs to. The OU for obtaining the Access Token should be consistent with the value of the request parameter orgId.

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
ruleIds	Required	List	The list of message rule IDs.

Response Parameters¶

Name	Data Type	Description
data	Boolean	Whether the message rule is deleted successfully. `true` means the deletion is successful. `false` means the deletion fails.

Error Codes¶

Error Code	Description
31400	The OU ID or message rule ID is empty.
31404	The OU or message rule does not exist.

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/message-service/rule/delete?orgId=your_org_id

method: POST

requestBody:
{
    "ruleIds": ["your_rule_id_1", "your_rule_id_2"]
}

Return Sample¶

{
    "code": 0,
    "message": "OK",
    "data": true
}