> For the complete documentation index, see [llms.txt](https://docs.toomuchmedia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toomuchmedia.com/api/api-endpoints/option/api-option-rule.md).

# /api/option/rule

## GET /api/option/rule

> Get rules for a particular join option

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/option/rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_option_rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["optionid"]}}},"paths":{"/api/option/rule":{"get":{"description":"Get rules for a particular join option","tags":["/api/option/rule"],"parameters":[{"name":"optionid","in":"query","schema":{"type":"integer"},"required":true},{"name":"rule_type","in":"query","schema":{},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_option_rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_option_rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_option_rule"}}}}}}}}}
```

## POST /api/option/rule

> Add a rule for a given join option

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/option/rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_option_rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["optionid","rule_type"]}}},"paths":{"/api/option/rule":{"post":{"description":"Add a rule for a given join option","tags":["/api/option/rule"],"parameters":[{"name":"optionid","in":"query","schema":{},"required":true},{"name":"rule_type","in":"query","schema":{},"required":true},{"name":"loginid","in":"query","schema":{"default":0},"required":false},{"name":"siteid","in":"query","schema":{"default":0},"required":false},{"name":"tourid","in":"query","schema":{"default":0},"required":false},{"name":"programid","in":"query","schema":{"default":0},"required":false},{"name":"billerid","in":"query","schema":{"default":0},"required":false},{"name":"country","in":"query","schema":{},"required":false},{"name":"start_time","in":"query","schema":{"default":"NOW"},"required":false},{"name":"end_time","in":"query","schema":{"default":"NEVER"},"required":false},{"name":"cascadeid","in":"query","schema":{"default":0},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_option_rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_option_rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_option_rule"}}}}}}}}}
```

## PATCH /api/option/rule

> Edit a given join option rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/option/rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_option_rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["option_rule_id","rule_type"]}}},"paths":{"/api/option/rule":{"patch":{"description":"Edit a given join option rule","tags":["/api/option/rule"],"parameters":[{"name":"option_rule_id","in":"query","schema":{},"required":true},{"name":"rule_type","in":"query","schema":{},"required":true},{"name":"loginid","in":"query","schema":{"default":0},"required":false},{"name":"siteid","in":"query","schema":{"default":0},"required":false},{"name":"tourid","in":"query","schema":{"default":0},"required":false},{"name":"programid","in":"query","schema":{"default":0},"required":false},{"name":"billerid","in":"query","schema":{"default":0},"required":false},{"name":"country","in":"query","schema":{},"required":false},{"name":"cascadeid","in":"query","schema":{"default":0},"required":false},{"name":"start_time","in":"query","schema":{"default":0},"required":false},{"name":"end_time","in":"query","schema":{"default":0},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_option_rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_option_rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_option_rule"}}}}}}}}}
```