Campaigns by tag
Campaigns are optional metadata attached to content. A campaign does not
replace the content type; set the type for the recipient experience and add a
campaign object when the delivery belongs to a campaign.
Common payload
Section titled “Common payload”Every content request still needs a recipient identifier, subject, and
type. Add the optional campaign object to associate the delivery with a
campaign tag.
| Field | Purpose |
|---|---|
ssn, email, or vat_number |
Identifies the person or company recipient |
subject |
Short inbox title; never include personal or sensitive information |
type |
Selects the content experience |
parts |
Contains the content document |
generated_at |
Optional timestamp used for inbox sorting |
campaign |
Associates the content with a campaign using its tag |
{ "ssn": "YYYYMMDDNNNN", "subject": "Summer offer", "type": "letter", "parts": [ { "name": "summer-offer.pdf", "content_type": "application/pdf", "data": "BASE64_ENCODED_PDF" } ], "campaign": { "tag": "summer_2026" }}campaign
Section titled “campaign”The campaign object requires a tag that identifies the campaign to attach.
The content request is still processed if the tag does not refer to an
existing campaign, so validate campaign tags in your integration before
sending.
See the Send content endpoint for the required field.
Retained delivery: Campaign metadata does not change retention. Retention
is determined by the selected content type; use the relevant content guide to
check whether retain is supported.