Create Campaign
print_mail.campaigns.create(CampaignCreateParams**kwargs) -> Campaign
POST/print-mail/v1/campaigns
Create a new campaign.
A campaign links a mailing list with a specific mail piece configuration (letter, postcard, cheque, self-mailer, or snap pack) to send bulk mail. Only one collateral type can be set per campaign.
Upon creation, the campaign enters the drafting status while assets are validated.
Parameters
default_sender_contact: Optional[str]
The ID of the default sender contact to use for orders if not specified per recipient.
description: Optional[str]
An optional string describing this resource. Will be visible in the API and the dashboard.
Create Campaign
import os
from postgrid import PostGrid
client = PostGrid(
print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"), # This is the default and can be omitted
)
campaign = client.print_mail.campaigns.create(
mailing_list="mailingList",
)
print(campaign.id){
"id": "campaign_sqF12lZ1VlBb",
"createdAt": "2019-12-27T18:11:19.117Z",
"createdCount": 0,
"live": true,
"mailingList": "mailingList",
"status": "drafting",
"updatedAt": "2019-12-27T18:11:19.117Z",
"cheque": {
"bankAccount": "bankAccount",
"currencyCode": "CAD",
"description": "description",
"envelope": "envelope",
"letterSettings": {
"color": true
},
"letterTemplate": "letterTemplate",
"letterUploadedPDF": "https://example.com",
"logo": "https://example.com",
"mailingClass": "first_class",
"memo": "memo",
"mergeVariables": {
"foo": "bar"
},
"message": "message",
"metadata": {
"foo": "string"
},
"returnEnvelope": "returnEnvelope",
"size": "us_letter"
},
"defaultSenderContact": "defaultSenderContact",
"description": "description",
"errors": [
{
"message": "message",
"type": "processing_error"
}
],
"letter": {
"addressPlacement": "top_first_page",
"attachedPDF": {
"file": "https://example.com",
"placement": "before_template"
},
"color": true,
"description": "description",
"doubleSided": true,
"envelope": "envelope",
"envelopeType": "standard_double_window",
"mailingClass": "first_class",
"mergeVariables": {
"foo": "bar"
},
"metadata": {
"foo": "string"
},
"paper": "standard",
"perforatedPage": 1,
"returnEnvelope": "returnEnvelope",
"size": "us_letter",
"template": "template",
"uploadedPDF": "https://example.com"
},
"metadata": {
"foo": "bar"
},
"orderPreviewURL": "https://example.com",
"postcard": {
"backTemplate": "backTemplate",
"description": "description",
"frontTemplate": "frontTemplate",
"mailingClass": "first_class",
"mergeVariables": {
"foo": "bar"
},
"metadata": {
"foo": "string"
},
"paper": "standard",
"size": "6x4",
"uploadedPDF": "https://example.com"
},
"reportURL": "https://example.com",
"selfMailer": {
"description": "description",
"insideTemplate": "insideTemplate",
"mailingClass": "first_class",
"mergeVariables": {
"foo": "bar"
},
"metadata": {
"foo": "string"
},
"outsideTemplate": "outsideTemplate",
"size": "8.5x11_bifold",
"uploadedPDF": "https://example.com"
},
"sendDate": "2019-12-27T18:11:19.117Z",
"snapPack": {
"description": "description",
"insideTemplate": "insideTemplate",
"mailingClass": "first_class",
"mergeVariables": {
"foo": "bar"
},
"metadata": {
"foo": "string"
},
"outsideTemplate": "outsideTemplate",
"size": "8.5x11_bifold_v",
"uploadedPDF": "https://example.com"
}
}Returns Examples
{
"id": "campaign_sqF12lZ1VlBb",
"createdAt": "2019-12-27T18:11:19.117Z",
"createdCount": 0,
"live": true,
"mailingList": "mailingList",
"status": "drafting",
"updatedAt": "2019-12-27T18:11:19.117Z",
"cheque": {
"bankAccount": "bankAccount",
"currencyCode": "CAD",
"description": "description",
"envelope": "envelope",
"letterSettings": {
"color": true
},
"letterTemplate": "letterTemplate",
"letterUploadedPDF": "https://example.com",
"logo": "https://example.com",
"mailingClass": "first_class",
"memo": "memo",
"mergeVariables": {
"foo": "bar"
},
"message": "message",
"metadata": {
"foo": "string"
},
"returnEnvelope": "returnEnvelope",
"size": "us_letter"
},
"defaultSenderContact": "defaultSenderContact",
"description": "description",
"errors": [
{
"message": "message",
"type": "processing_error"
}
],
"letter": {
"addressPlacement": "top_first_page",
"attachedPDF": {
"file": "https://example.com",
"placement": "before_template"
},
"color": true,
"description": "description",
"doubleSided": true,
"envelope": "envelope",
"envelopeType": "standard_double_window",
"mailingClass": "first_class",
"mergeVariables": {
"foo": "bar"
},
"metadata": {
"foo": "string"
},
"paper": "standard",
"perforatedPage": 1,
"returnEnvelope": "returnEnvelope",
"size": "us_letter",
"template": "template",
"uploadedPDF": "https://example.com"
},
"metadata": {
"foo": "bar"
},
"orderPreviewURL": "https://example.com",
"postcard": {
"backTemplate": "backTemplate",
"description": "description",
"frontTemplate": "frontTemplate",
"mailingClass": "first_class",
"mergeVariables": {
"foo": "bar"
},
"metadata": {
"foo": "string"
},
"paper": "standard",
"size": "6x4",
"uploadedPDF": "https://example.com"
},
"reportURL": "https://example.com",
"selfMailer": {
"description": "description",
"insideTemplate": "insideTemplate",
"mailingClass": "first_class",
"mergeVariables": {
"foo": "bar"
},
"metadata": {
"foo": "string"
},
"outsideTemplate": "outsideTemplate",
"size": "8.5x11_bifold",
"uploadedPDF": "https://example.com"
},
"sendDate": "2019-12-27T18:11:19.117Z",
"snapPack": {
"description": "description",
"insideTemplate": "insideTemplate",
"mailingClass": "first_class",
"mergeVariables": {
"foo": "bar"
},
"metadata": {
"foo": "string"
},
"outsideTemplate": "outsideTemplate",
"size": "8.5x11_bifold_v",
"uploadedPDF": "https://example.com"
}
}