Quick Start Guide with Mail Merge
This quick start guide is for customers that wish to use variable data (mail merge) in their mailing.
Before you do the following steps you need to create a test account and agree to the the API Terms of Service; the instructions for this are here. In order to use the test system you will need to follow the instructions described here.
Step 1. Create Job Template
The job template defines the product, print and mailing options that you will use in your job submission. You will need to create a separate job template for each variation of product options that will be printed and mailed through the API. You will use the job template in the Create Job from Template function to create a job with your mail merge document
- Login to click2mail.com and go to My Accounts - Job Templates.
- Create a new REST API job template with your print and mail options and the mail merge document
- You can test the template in our UI by clicking the Start Job Button in the template which will create the job in our ui. Upload a sample address list that matches the list columns used when creating the mail merge document. Click contine on the job which will take you to the proof page where you can download a proof and review that the mail merge is working correctly.
Step 2. Test the Job Template in the Rest API
- Create the job using Create Job from Template. function.
- Upload your mailing list using Create Address List.
- Update the job with the mailing list ID using Update Job.
- Submit the job using Submit Job.
This is the basic workflow for create a job using the Click2Mail Mail Merge feature.
There are many advanced calls to enable.
- Pulling a Proof
- Aquiring the job status
- Pulling the USPS mail piece tracking infomation
- We have many advanced features to enable web developers to create their own white label sites, applications and mobile apps. We use these features for our own websites and apps.
There are SDK kits on our Click2Mail GitHub Account.
If you need assistance please contact our API support specialists at [email protected] or by phone at 1-855-294-5601.