Create New Campaign
Create a new campaign given the parameters below. Before a new campaign is created, a template must be created and proofed. The template id must be included in this call
object
CreditTypeId
integer (int32)
required
Identifies the type of media being used in this campaign. Options are:
- 21 - 4x6 postcards first class
- 22 - 6x9 postcards first class
- 23 - 6x11 postcards first class
- 24 - letters first class
- 28 - bifold 12x9 first class
- 29 - bifold 6x18 first class
- 32 - 6x9 postcards standard
- 33 - 6x11 postcards standard
- 34 - letters standard
- 28 - bifold 12x9 standard
- 29 - bifold 6x18 standard
Example:
34
DirectMailName
string
required
The name for this campaign
Example:
Keymaker
PostageType
integer (int32)
required
The postage type to be used in this campaign. Options are:
- 0 - first class
- 1 - standard
Example:
10142067
SenderAddress1
string
required
The sender's address 1
Example:
36 Pipers Row
SenderCity
string
required
The sender's city
Example:
New York
SenderName
string
required
The sender of this campaign
Example:
Metacortex
SenderState
string
required
The sender's state
Example:
NY
SenderZip
string
required
The sender's zip code
Example:
10001
TemplateFrontId
integer (int32)
required
The id of the template to be used in this campaign.
Example:
10142067
SenderAddress2
string
nullable
The sender's address 2
Example:
Room 101
SenderCountry
string
nullable
default: US
The sender's country
Example:
US
TemplateEnvelopeId
integer (int32)
The id of the custom envelope to be used in this campaign if this is a letter campaign using a custom envelope.
Example:
10142067
Response
application/json
object
temporary
created_date
string (date-time)
The date and time when the direct mail drop was created.
Example:
1999-02-19T12:00:00.00:00
drop_id
integer (int32)
The unique identifier for the direct mail drop.
Example:
10142067
Code Examples
Response