LetterStream API Information
We currently have three modes for our API, which tech-savvy customers can use to push documents directly to our servers. Please be sure to read the information contained in this article to determine if our API is a good fit for you and what mode might best fit your needs.
In This Article
General Information
LetterStream's API allows companies to further speed up their mail processes, but we do have a few requirements. Here are a few things to keep in mind for all of our API modes:
- Our system only works with PDFs and CSVs, so your program should be able to generate those.
- Mailings can be submitted to us, but they won't be processed until they are paid for. Utilizing the PrePay option is the best way to ensure a smooth mailing process. We also recommend setting up a Low Balance Alert.
- We do require that either you are a developer, you have a developer in-house, or you are okay with contracting out a developer to execute the code required on your end to tie into our website.
Supported Mail Types
The API supports First-Class letters with an optional "Homeowner Statement Enclosed" endorsement on the outer envelope, Certified mail with or without an Electronic Return Receipt, Flats, and Postcards.
API Modes
As mentioned, we have three different modes for our API: Automation, Monetization, and Partnership. Each mode has different levels of interaction between LetterStream, your company, and potentially your customers.
Automation Mode
Our Automation Mode is perfect for companies looking to speed their own internal mailing processes beyond what our website provides by default. This is the most common option and is the fastest to integrate.
Of course, we will continue providing you with the service and support you’re accustomed to as your team creates and sends mail through the API.
Monetization Mode
With Monetization Mode, your company can sell our printing and mailing services to your customers at your desired price. Customers can create and pay for mailings on your website before they are sent to us through one main company account.
This takes a bit more setup on your end than our Automation Mode. You will need to manage the pricing, billing, and ongoing support for your customers, as we will not have a relationship with them.
Partnership Mode
Through the Partnership Mode, your company will have a special partner link for your clients to create their own account with us. Each of your customers will have their own account to create their mailings and will provide payment to us directly at our set prices.
Our team will provide support to your customers while using our platform, while your company supports customers as they set up and connect accounts.
Using the Partnership Mode will require more setup than our other options, but our team will be happy to provide you with the next steps once activated.
API Activation
We like to know who's utilizing our API and to help make sure it's the right fit, therefore the API isn't available by default within your account. We spend a lot of time making sure our website is powerful and efficient, and in some cases, it might even be better to send mail through your LetterStream Account.
Please keep in mind that we don't integrate the API on your behalf, but rather that needs to be accomplished by a developer on your end. Once activated, instructions and documentation can be found on the API Information page, under the My Account tab.
If you'd like to pursue the possibility of utilizing our API, send us an email and we’d be happy to provide you with more information.