Skip to content

Commit

Permalink
Add missing header field in campaign creation docs. Closes #1561.
Browse files Browse the repository at this point in the history
  • Loading branch information
knadh committed Nov 1, 2023
1 parent ccceaa6 commit 3641f74
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/docs/content/apis/campaigns.md
Expand Up @@ -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. |
| `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. |
| `headers` | []Map | Optional | Array of key-value pairs to be sent as SMTP headers. eg: `[{"x-custom-header": "value"}]`. |



Expand Down Expand Up @@ -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.
`status` | Request Body | String | Required | `scheduled`, `running`, `paused`, `cancelled`.


###### Note:
> * Only "scheduled" campaigns can be saved as "draft".
* Only "draft" campaigns can be "scheduled".
Expand Down

0 comments on commit 3641f74

Please sign in to comment.