Stannp | Direct Mail Marketing Platform

Objects

Reference documentation for the data objects returned by the API.

Mailpiece Object

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

Parameters

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

Campaign Object

The object model of a campaign.

Parameters

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

Recipient Object

The object model of a recipient.

Parameters

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