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.

Parameters for updating an existing campaign. Only campaigns in 'draft' or 'changes_required' status can be updated.

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. Setting this will remove other collateral types. Set to null to remove.

postcard
object | null

Inline postcard configuration. Setting this will remove other collateral types. Set to null to remove.

cheque
object | null

Inline cheque configuration. Setting this will remove other collateral types. Set to null to remove.

selfMailer
object | null

Inline self-mailer configuration. Setting this will remove other collateral types. Set to null to remove.

snapPack
object | null

Inline snap pack configuration. Setting this will remove other collateral types. Set to null to remove.

string | null

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

Responses

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?