campaign_mailings

Create a campaign mailing

Creates a campaign mailing (a marketing email) for the authenticated customer. Creating a mailing only stores the content; use send a campaign or schedule a campaign to deliver it.

subject is required and must be unique within your account. An unsubscribe footer is appended to html_part automatically on save.

Example curl command:

curl -X POST \
https://api.paubox.com/v1/marketing/campaign_mailings \
  -H 'authorization: Token token=YOUR_API_KEY' \
  -H 'content-type: application/json' \
  -d '{
    "campaign_mailing": {
        "subject": "March newsletter",
        "html_part": "<html><body><div>Hello</div></body></html>",
        "text_part": "Hello",
        "template_type": "html"
    }
  }'
post/campaign_mailings

Request

  • Base URL: https://api.paubox.com/v1/marketing
  • URL: https://api.paubox.com/v1/marketing/campaign_mailings
  • Auth: API key in header authorization

Request body

Response

The new campaign mailing's ID. If validation fails the response is still 200 but the body contains an errors array instead of data.

errorsstring[]

Validation messages, present only when the write failed

Changes

No recorded changes to this operation across all 1 revision of this API.