> 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.md).

# /api/mailing/mailing

## GET /api/mailing/mailing

> Get mailing details

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

## POST /api/mailing/mailing

> Add new mailing

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/mailing/mailing"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"post_mailing_mailing":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["subject","send_on"]}}},"paths":{"/api/mailing/mailing":{"post":{"description":"Add new mailing","tags":["/api/mailing/mailing"],"parameters":[{"name":"subject","in":"query","schema":{"type":"string"},"required":true},{"name":"type","in":"query","schema":{"type":"string"},"required":false},{"name":"send_on","in":"query","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/post_mailing_mailing"}},"application/json":{"schema":{"$ref":"#/components/schemas/post_mailing_mailing"}},"application/xml":{"schema":{"$ref":"#/components/schemas/post_mailing_mailing"}}}}}}}}}
```

## DELETE /api/mailing/mailing

> Delete maling

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

## PATCH /api/mailing/mailing

> Edit mailing

```json
{"openapi":"3.0.2","info":{"title":"API Specification","version":"v1"},"tags":[{"name":"/api/mailing/mailing"}],"security":[{"api-key":[],"api-username":[]}],"components":{"securitySchemes":{"api-key":{"type":"apiKey","in":"header","name":"api-key"}},"schemas":{"patch_mailing_mailing":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["mailid"]}}},"paths":{"/api/mailing/mailing":{"patch":{"description":"Edit mailing","tags":["/api/mailing/mailing"],"parameters":[{"name":"mailid","in":"query","schema":{"type":"integer"},"required":true},{"name":"subject","in":"query","schema":{"type":"string"},"required":false},{"name":"only_once","in":"query","schema":{"type":"string"},"required":false},{"name":"email_once","in":"query","schema":{"type":"string"},"required":false},{"name":"send_on","in":"query","schema":{"type":"string"},"required":false},{"name":"body","in":"query","schema":{"type":"string"},"required":false},{"name":"body_html","in":"query","schema":{"type":"string"},"required":false}],"responses":{"200":{"description":"success","content":{"text/php":{"schema":{"$ref":"#/components/schemas/patch_mailing_mailing"}},"application/json":{"schema":{"$ref":"#/components/schemas/patch_mailing_mailing"}},"application/xml":{"schema":{"$ref":"#/components/schemas/patch_mailing_mailing"}}}}}}}}}
```