Push notifications

Enable or disable a push rule.

This endpoint allows clients to enable or disable the specified push rule.

put/_matrix/client/v3/pushrules/global/{kind}/{ruleId}/enabled

Request

Base URL
https://matrix.org
Auth
- API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/pushrules/global/:kind/:ruleId/enabled/put.ts
A function with typed inputs. Its response is checked against the schema.

kind'override' | 'underride' | 'sender' | 'room' | 'content' required

The kind of rule

ruleIdstring required

The identifier for the rule.

enabledboolean required

Whether the push rule is enabled or not.

{
  "enabled": true
}

The push rule was enabled or disabled.

object required

No recorded changes to this operation across all 1 revision of this API.