Sign in
Campaigns

Get Campaign

Retrieve a specific campaign by its ID.

get/print-mail/v1/campaigns/{id}

Path parameters

idstring required

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

Response

The requested campaign details.

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.1711

  • 537d2bbc624a11See the full diff
    • ▲

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

      response-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 200

      response-property-any-of-removed

  • afd5935c2b2c3See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-property-all-of-added

    • ○

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

      response-property-all-of-removed

  • c8fedcbd705e77See the full diff
    • ●

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

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ●

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

      response-optional-property-removed

    • ●

      removed the optional property selfMailerProfile from the response with the 200 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 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 200 status

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    • ○

      added the optional property snapPack to the response with the 200 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