Print and Mail FAQAddress Verification FAQ
API Reference

Update Campaign

post
https://api.postgrid.com/print-mail/v1/campaigns/

Update an existing campaign.

Campaigns can only be updated if they are in the draft or changes_required status. Updating a campaign will trigger reprocessing and set its status back to drafting.

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

The unique identifier (campaign_...) for the campaign to update.

Body Params

The fields to update on the campaign.

string | null

An optional description for the campaign. Set to null to remove the existing description.

metadata
object | null

Optional key-value data associated with the campaign. Set to null to remove existing metadata.

string

The ID of the mailing list to associate with this campaign.

letter
object | null

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

postcard
object | null

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

cheque
object | null

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

selfMailer
object | null

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

snapPack
object | null

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

string | null

The ID of the default sender contact. Set to null to remove.

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