Sign in
Campaigns

Create Campaign

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.

post/print-mail/v1/campaigns

Headers

idempotency-keystring

Request body

descriptionstring

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

metadataobject

See the section on Metadata.

defaultSenderContactstring

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

mailingListstring required

The ID of the mailing list associated with this campaign.

sendDatestring date-time

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

Response

The newly created campaign in drafting status.

idstring required

A unique ID prefixed with campaign_

descriptionstring

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

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.

status'drafting' | 'changes_required' | 'creating_orders' | 'draft' | 'ready' | 'printing' | 'processed_for_delivery' required

Status of the campaign lifecycle.

defaultSenderContactstring

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

mailingListstring required

The ID of the mailing list associated with this campaign.

createdCountinteger required

The number of orders successfully created for this campaign.

orderPreviewURLstring uri

A temporary URL to preview the first rendered order, available once the campaign status is 'draft' or later.

sendDatestring date-time

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

reportURLstring uri

A temporary URL to download the processing report, available once the campaign is in the ready status.

Changes

Changed in 3 of the 7 revisions of this API.81324

  • 537d2bbc624a78See the full diff
    • ▲

      removed subschema #1 subschema #2 from the cheque/allOf[CampaignChequeFieldsCreate]/letterPDF request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the letter/allOf[CampaignLetterFieldsCreate]/attachedPDF/allOf[AttachedPDF]/file request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the letter/allOf[CampaignLetterFieldsCreate]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the postcard/allOf[CampaignPostcardFieldsCreate]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the selfMailer/allOf[CampaignSelfMailerFieldsCreate]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the snapPack/allOf[CampaignSnapPackFieldsCreate]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      added BinaryFile subschema #1 to the letter/allOf[CampaignLetterFields]/attachedPDF/allOf[AttachedPDF]/file response property oneOf list for the response status 201

      response-property-one-of-added

    • ○

      added the media type multipart/form-data to the request body

      request-body-media-type-added

    • ○

      added BinaryFile subschema #1 to the cheque/allOf[CampaignChequeFieldsCreate]/letterPDF request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the letter/allOf[CampaignLetterFieldsCreate]/attachedPDF/allOf[AttachedPDF]/file request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the letter/allOf[CampaignLetterFieldsCreate]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the postcard/allOf[CampaignPostcardFieldsCreate]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the selfMailer/allOf[CampaignSelfMailerFieldsCreate]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the snapPack/allOf[CampaignSnapPackFieldsCreate]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      removed subschema #1 subschema #2 from the letter/allOf[CampaignLetterFields]/attachedPDF/allOf[AttachedPDF]/file response property anyOf list for the response status 201

      response-property-any-of-removed

  • afd5935c2b2c114See the full diff
    • ▲

      added PostcardPremiumPaperID to the postcard/allOf[CampaignPostcardFieldsCreate]/paper request property allOf list

      request-property-all-of-added

    • ●

      removed PremiumPaperID from the postcard/allOf[CampaignPostcardFieldsCreate]/paper request property allOf list

      request-property-all-of-removed

    • ○

      added the new optional request property letter/allOf[CampaignLetterFieldsCreate]/paper

      new-optional-request-property

    • ○

      added the optional property letter/allOf[CampaignLetterFields]/paper to the response with the 201 status

      response-optional-property-added

    • ○

      added PostcardPremiumPaperID to the postcard/allOf[CampaignPostcardFields]/paper response property allOf list for the response status 201

      response-property-all-of-added

    • ○

      removed PremiumPaperID from the postcard/allOf[CampaignPostcardFields]/paper response property allOf list for the response status 201

      response-property-all-of-removed

  • c8fedcbd705e1212See the full diff
    • ●

      removed the request property chequeProfile

      request-property-removed

    • ●

      removed the request property letterProfile

      request-property-removed

    • ●

      removed the request property postcardProfile

      request-property-removed

    • ●

      removed the request property selfMailerProfile

      request-property-removed

    • ●

      removed the optional property chequeProfile from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property letterProfile from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property postcardProfile from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property selfMailerProfile from the response with the 201 status

      response-optional-property-removed

    • ●

      added the new internal_server_error enum value to the error/type response property for the response status 500

      response-property-enum-value-added

    • ●

      added the new not_found_error enum value to the error/type response property for the response status 404

      response-property-enum-value-added

    • ●

      added the new rate_limit_exceeded_error enum value to the error/type response property for the response status 429

      response-property-enum-value-added

    • ●

      added the new validation_error enum value to the error/type response property for the response status 400

      response-property-enum-value-added

    • ○

      added the new optional request property cheque

      new-optional-request-property

    • ○

      added the new optional request property letter

      new-optional-request-property

    • ○

      added the new optional request property postcard

      new-optional-request-property

    • ○

      added the new optional request property selfMailer

      new-optional-request-property

    • ○

      added the new optional request property snapPack

      new-optional-request-property

    • ○

      added subschema #1 subschema #2 to the response body anyOf list for the response status 401

      response-body-any-of-added

    • ○

      removed subschema #1 subschema #2 from the response body anyOf list for the response status 401

      response-body-any-of-removed

    • ○

      added the optional property cheque to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property letter to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property postcard to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property selfMailer to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property snapPack to the response with the 201 status

      response-optional-property-added

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog