Print and Mail FAQAddress Verification FAQ
API Reference

Create Campaign

post
https://api.postgrid.com/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the campaign to create.

string

An optional string describing this resource. Will be visible in the API and the dashboard.

metadata
object

See the section on Metadata.

string

The ID of the default sender contact to use for orders if not specified per recipient.

string
required

The ID of the mailing list associated with this campaign.

letter
object

Inline letter configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.

postcard
object

Inline postcard configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.

cheque
object

Inline cheque configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.

selfMailer
object

Inline self-mailer configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.

snapPack
object

Inline snap pack configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.

date-time

The scheduled date and time for the campaign to be sent.

Headers
string
Responses

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago