Docs
Add Reset Condition
POST /rule-sets/{ruleSetId}/rules/{ruleId}/reset-conditions
POST
/rule-sets/{ruleSetId}/rules/{ruleId}/reset-conditionsRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
Adds a reset condition: what restarts the rule's clock.
Requires
EventSettings permission on the event.Event scoping: This endpoint does not include
{eventId} in the URL. The event is determined automatically from your x-Event-Token.Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| ruleSetId | Guid | Required | The rule set. |
| ruleId | Guid | Required | The rule. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| resetType | string | Required | `ScheduleGap`, `BlockType` or `CalendarPeriod`. |
| blockTypeId | Guid? | Optional | For `BlockType`. |
| minDuration | decimal? | Optional | Minimum gap or block length. |
| durationUnit | string | Optional | `Hours`, `Minutes` or `Days`. |
| period | string | Optional | `Day`, `Week` or `Month`, for `CalendarPeriod`. |
| periodStartDay | string | Optional | Day the period starts on. |
| thresholdOverrides | array | Optional | `{ ruleThresholdId, threshold, thresholdUnit }`: per-threshold values after this reset. |
Response
201 Created. No response body.
Error Codes
| HTTP Status | Description |
|---|---|
| 400 | Invalid arguments. |
| 404 | Rule set, rule or block type not found. |