beenull/listmonk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add missing header field in campaign creation docs. Closes #1561.

Browse source
This commit is contained in:
Kailash Nadh 2023-11-01 18:49:48 +05:30
parent ccceaa6e92
commit 3641f74c64
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docs/content/apis/campaigns.md
View file

@ -208,6 +208,7 @@ Creates a new campaign.
| `messenger` | String | Optional | `email` or a custom messenger defined in the settings. If left empty, `email` is used. | | `messenger` | String | Optional | `email` or a custom messenger defined in the settings. If left empty, `email` is used. |
| `template_id` | Number | Optional | ID of the template to use. If left empty, the default template is used. | | `template_id` | Number | Optional | ID of the template to use. If left empty, the default template is used. |
| `tags` | []String | Optional | Array of string tags to mark the campaign. | | `tags` | []String | Optional | Array of string tags to mark the campaign. |
| `headers` | []Map | Optional | Array of key-value pairs to be sent as SMTP headers. eg: `[{"x-custom-header": "value"}]`. |
@ -264,7 +265,6 @@ Name | Parameter Type | Data Type | Required/Optional | Description
`campaign_id` | Path Parameter | Number | Required | The id value of the campaign whose status is to be modified. `campaign_id` | Path Parameter | Number | Required | The id value of the campaign whose status is to be modified.
`status` | Request Body | String | Required | `scheduled`, `running`, `paused`, `cancelled`. `status` | Request Body | String | Required | `scheduled`, `running`, `paused`, `cancelled`.
###### Note: ###### Note:
> * Only "scheduled" campaigns can be saved as "draft". > * Only "scheduled" campaigns can be saved as "draft".
* Only "draft" campaigns can be "scheduled". * Only "draft" campaigns can be "scheduled".