Rewards and loyalty
Disable a reward rule; existing grants stand
Stops a rule being evaluated from now on.
POST
/v1/reward_rules/{ruleId}/disableStops a rule being evaluated from now on. Grants it already made stand, and the rule stays in the listing so a past grant can still be explained. Requires rewards:manage; an unknown rule gives rule_not_found (404). Audited.
Authorization
bearerAuth AuthorizationBearer <token>
A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
ruleId*string
Format
uuidResponse Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/reward_rules/497f6eca-6276-4993-bfeb-53cbbbba6f08/disable"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "params": {}, "scope": {}, "caps": {}, "starts_at": "2019-08-24T14:15:22Z", "ends_at": "2019-08-24T14:15:22Z", "version": 0, "status": "string", "created_at": "2019-08-24T14:15:22Z", "disabled_at": "2019-08-24T14:15:22Z"}