Mail merge

Create a campaign

Parses the recipient list, maps its columns to the template's fields and validates every row. Returns a draft with a validation report (201), or with start: true and consent, queues it straight away (202). Each email the mail server accepts costs one PDF credit.

post/mailmerge/campaigns

Request

  • Base URL: https://api.podpdf.com
  • URL: https://api.podpdf.com/mailmerge/campaigns
  • Auth: API key in header X-API-Key

Request body

namestring
template_idstring
connection_idstring
email_columnstring

Detected from the headers when left out.

mappingobject

Template field key to column name. Unmapped fields are matched by key or label.

email_notificationboolean

false skips the "campaign finished" email to you.

startboolean

Queue the campaign now (needs consent).

Example request

{
  "email": {
    "subject": "Your statement, {{customer.name}}"
  }
}

Response

Draft created

Example response

{
  "campaign": {
    "email": {
      "subject": "Your statement, {{customer.name}}"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.