Mailpiece Object

The object model of any mailpiece such as a Postcard, Letter, Greeting card etc.

Model

id The mailpiece id.
timestamp Creation timestamp "YYYY-MM-DD HH:MM:SS"
status The status of the mailpiece.
See the reporting page for a list of statuses.
type The mailpiece type.
format The template format.
pdf_file A url of a pdf representation.
dispatched Dispatched timestamp "YYYY-MM-DD HH:MM:SS". null if not marked as dispatched yet.
cost The unit cost of this item.
addons Comma separated list of addon codes.
tags Any reference tags which can be used for filtering and searching your mailpieces.

Campaign Object

The object model of a campaign.

Model

id The campaign id.
template_id The template ID associated with the campaign.
status The status of the campaign.
Draft, approved, provisioned, scheduled, running, paused, complete.
type The campaign type.
created Created timestamp ISO 8601 format.
updated Updated timestamp ISO 8601 format.
send_date The scheduled send date. ISO 8601 format.
dispatched Dispatched timestamp ISO 8601 format. null if not marked as dispatched yet.
cost The cost of the campaign.
addons Comma separated list of addon codes.
image Thumbnail image of the campaign after it has been approved

Recipient Object

The object model of recipient.

Model

id The recipient id.
email Recipient emaill address.
title Recipient title eg: Mr, Mrs etc
firstname First name of the recipient.
lastname Last name of the recipient.
company Recipients company
job_title Recipients job title
address1 Address line 1
address2 Address line 2
address3 Address line 3
city City or town.
county County or state
country Country code in ISO 3166-1 alpha-2 format
postcode Postal code / zip code.
dps Delivery point suffix.
ref_id A reference ID for use to match recipient with another system.
blacklist Recipient has been blacklisted or not.