> 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/mailing/api-mailing-mailing-rule.md).

# /api/mailing/mailing‑rule

## GET /api/mailing/mailing-rule

> Get a mailing rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/mailing/mailing-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"get_mailing_mailing-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["mailid","ruleid"]}}},"paths":{"/api/mailing/mailing-rule":{"get":{"description":"Get a mailing rule","tags":["/api/mailing/mailing-rule"],"parameters":[{"name":"mailid","in":"query","schema":{"type":"integer"},"required":true},{"name":"ruleid","in":"query","schema":{"type":"string","pattern":"/^[0-9]+:[0-9]+:[0-9]+$/"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/get_mailing_mailing-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/get_mailing_mailing-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/get_mailing_mailing-rule"}}}}}}}}}
```

## POST /api/mailing/mailing-rule

> Add new mailer rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/mailing/mailing-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_mailing_mailing-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["mailid","rule_type"]}}},"paths":{"/api/mailing/mailing-rule":{"post":{"description":"Add new mailer rule","tags":["/api/mailing/mailing-rule"],"parameters":[{"name":"mailid","in":"query","schema":{"type":"integer"},"required":true},{"name":"rule_type","in":"query","schema":{"type":"string"},"required":true},{"name":"login","in":"query","schema":{"type":"string"},"required":false},{"name":"option","in":"query","schema":{"type":"string"},"required":false},{"name":"program","in":"query","schema":{"type":"string"},"required":false},{"name":"site","in":"query","schema":{"type":"string"},"required":false},{"name":"tour","in":"query","schema":{"type":"string"},"required":false},{"name":"biller","in":"query","schema":{"type":"string"},"required":false},{"name":"mailok","in":"query","schema":{"type":"string"},"required":false},{"name":"trial","in":"query","schema":{"type":"string"},"required":false},{"name":"all_email","in":"query","schema":{"type":"string"},"required":false},{"name":"status","in":"query","schema":{"type":"integer"},"required":false},{"name":"status_compare","in":"query","schema":{"type":"string"},"required":false},{"name":"signup","in":"query","schema":{"type":"integer"},"required":false},{"name":"signup_compare","in":"query","schema":{"type":"string"},"required":false},{"name":"signup_timeframe","in":"query","schema":{"type":"integer"},"required":false},{"name":"amount","in":"query","schema":{"type":"integer"},"required":false},{"name":"amount_compare","in":"query","schema":{"type":"string"},"required":false},{"name":"amount_range","in":"query","schema":{"type":"integer"},"required":false},{"name":"traffic","in":"query","schema":{"type":"integer"},"required":false},{"name":"traffic_compare","in":"query","schema":{"type":"string"},"required":false},{"name":"traffic_range","in":"query","schema":{"type":"integer"},"required":false},{"name":"mailing_list_id","in":"query","schema":{"type":"integer"},"required":false},{"name":"start_time","in":"query","schema":{"default":"NOW","type":"string"},"required":false},{"name":"end_time","in":"query","schema":{"default":"FOREVER","type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_mailing_mailing-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_mailing_mailing-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_mailing_mailing-rule"}}}}}}}}}
```

## DELETE /api/mailing/mailing-rule

> Disable mailing rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/mailing/mailing-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"delete_mailing_mailing-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["mailid","ruleid"]}}},"paths":{"/api/mailing/mailing-rule":{"delete":{"description":"Disable mailing rule","tags":["/api/mailing/mailing-rule"],"parameters":[{"name":"mailid","in":"query","schema":{"type":"integer"},"required":true},{"name":"ruleid","in":"query","schema":{"type":"string","pattern":"/^[0-9]+:[0-9]+:[0-9]+$/"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/delete_mailing_mailing-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/delete_mailing_mailing-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/delete_mailing_mailing-rule"}}}}}}}}}
```

## PATCH /api/mailing/mailing-rule

> Edit mailer rule

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/mailing/mailing-rule"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_mailing_mailing-rule":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["mailid","ruleid","rule_type"]}}},"paths":{"/api/mailing/mailing-rule":{"patch":{"description":"Edit mailer rule","tags":["/api/mailing/mailing-rule"],"parameters":[{"name":"mailid","in":"query","schema":{"type":"integer"},"required":true},{"name":"ruleid","in":"query","schema":{"type":"string","pattern":"/^[0-9]+:[0-9]+:[0-9]+$/"},"required":true},{"name":"rule_type","in":"query","schema":{"type":"string"},"required":true},{"name":"login","in":"query","schema":{"type":"string"},"required":false},{"name":"option","in":"query","schema":{"type":"string"},"required":false},{"name":"program","in":"query","schema":{"type":"string"},"required":false},{"name":"site","in":"query","schema":{"type":"string"},"required":false},{"name":"tour","in":"query","schema":{"type":"string"},"required":false},{"name":"biller","in":"query","schema":{"type":"string"},"required":false},{"name":"mailok","in":"query","schema":{"type":"string"},"required":false},{"name":"trial","in":"query","schema":{"type":"string"},"required":false},{"name":"all_email","in":"query","schema":{"type":"string"},"required":false},{"name":"status","in":"query","schema":{"type":"integer"},"required":false},{"name":"status_compare","in":"query","schema":{"type":"string"},"required":false},{"name":"signup","in":"query","schema":{"type":"integer"},"required":false},{"name":"signup_compare","in":"query","schema":{"type":"string"},"required":false},{"name":"signup_timeframe","in":"query","schema":{"type":"integer"},"required":false},{"name":"amount","in":"query","schema":{"type":"integer"},"required":false},{"name":"amount_compare","in":"query","schema":{"type":"string"},"required":false},{"name":"amount_range","in":"query","schema":{"type":"integer"},"required":false},{"name":"traffic","in":"query","schema":{"type":"integer"},"required":false},{"name":"traffic_compare","in":"query","schema":{"type":"string"},"required":false},{"name":"traffic_range","in":"query","schema":{"type":"integer"},"required":false},{"name":"mailing_list_id","in":"query","schema":{"type":"integer"},"required":false},{"name":"start_time","in":"query","schema":{"default":"NOW","type":"string"},"required":false},{"name":"end_time","in":"query","schema":{"default":"FOREVER","type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_mailing_mailing-rule"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_mailing_mailing-rule"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_mailing_mailing-rule"}}}}}}}}}
```