Mailform (Preview)
The easiest way to print and mail letters and postcards: USPS First Class, Certified, Priority and Priority Express Mail.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Mailform Support |
| URL | https://help.mailform.io |
| support@mailform.io |
| Connector Metadata | |
|---|---|
| Publisher | Mailform, Inc. |
| Website | https://www.mailform.io |
| Privacy Policy | https://www.mailform.io/privacy |
| Terms of Service | https://www.mailform.io/terms |
| Categories | Business Management;Marketing |
The Mailform connector allows flows in the Power Automate environment to send physical mail: provide a PDF proof and some print specs such as color/black and white printing or simplex/duplex printing, and Mailform will print the document to spec, stuff it in an appropriate envelope, add postage and hand it off to the USPS (and soon, FedEx) on your behalf. The connector provides a single, straightforward method to do this: you could for example have a flow that reacts to a new user signup by sending them marketing documents, or sending a customer a postcard with a coupon 30 days after their order is shipped.
Prerequisites
You will need the following to proceed:
- A Mailform account with a valid, non-zero credit account (to pay for your print and mail jobs). Sign up for free at Mailform
How to get credentials
To obtain credentials:
- Log into your Mailform account at Mailform
- Go to your Billing settings by visiting Mailform Billing
- Click the Purchase Account Credit button, and then click the $25.00 option to add the minimum amount of credit to your account.
- Complete the payment process: this will create a credit account and add credit to your account.
- Go to the API Access settings by clicking on the API ACCESS tab or visiting Mailform API Access
- Click the NEW API TOKEN button, then give the token a label (such as Power Automate Testing). While testing, you can enable test mode for this key: all API requests will be accepted and verified, but no actual mail will be sent. Test mode orders will be accepted and then immediately cancelled, and will not affect your credit balance.
- The new API token will be shown: please copy it down, as it will NOT be displayed ever again. Note that test mode API tokens can never be switched out of test mode: when you are ready to go live you will need to create a new API token.
Get started with your connector
To demonstrate the use of Mailform, we will create a flow that will send a flyer with a coupon code on my birthday. In the Power Automate editor:
- Create a new flow by clicking the Create button.
- Select the Scheduled Cloud Flow option.
- Name the flow, and set the date and frequency (in this case, every 12 months on Dec 27th, 2023).
- Click the Create button.
- Click the plus icon and click on Add an action.
- In the dialog, search for Mailform, then select the Prints and mails a letter or postcard using Mailform action.
- Fill in the recipient and sender addresses.
- Fill in the document and print specifications: first click the Advanced Parameters option and then select url, and then enter the value https://www.mailform.io/samples/sampleflyer.pdf. Then click the Advanced Parameters option and then select color, and then select Yes.
- Click the Save button at the top of the editor, and we’re done. When the flow runs, the order will be placed within the Mailform account associated with the API key.
Known issues and limitations
- Print proofs must be less than 40 MB: if the PDF document you are mailing is more than 40 MB you will need to pre-process it to reduce the file size.
Common errors and remedies
N/A
FAQ
N/A
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The Mailform API Key to be used for this connection | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Gets an existing order |
Retrieve an existing order created via the API |
| Gets the authenticated user |
Retrieve information about the authenticated Mailform user |
| Prints and mails a letter or postcard using Mailform |
Creates a new Mailform order by providing the print proof as well as the order details (class of service, color/black and white, single-sided/double-sided printing and more) |
Gets an existing order
Retrieve an existing order created via the API
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Mailform Order ID
|
id | True | string |
The ID of the Mailform order |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
error.code | string |
error code |
|
message
|
error.message | string |
error message |
|
details
|
details | string |
other details |
|
success
|
success | boolean |
true on success |
|
id
|
data.id | string | |
|
lineitems
|
data.lineitems | array of object | |
|
id
|
data.lineitems.id | string | |
|
service
|
data.lineitems.service | string | |
|
tracking_number
|
data.lineitems.tracking_number | string |
Gets the authenticated user
Retrieve information about the authenticated Mailform user
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
email
|
string | ||
|
name
|
name | string | |
|
id
|
balance.id | string | |
|
amount
|
balance.amount | integer | |
|
currency
|
balance.currency | string |
Prints and mails a letter or postcard using Mailform
Creates a new Mailform order by providing the print proof as well as the order details (class of service, color/black and white, single-sided/double-sided printing and more)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
File
|
file | file |
The PDF document to be mailed |
|
|
URL
|
url | string |
URL from PDF will be downloaded |
|
|
Customer Reference
|
customer_reference | string |
An optional customer reference to be attached to the order |
|
|
Delivery Service
|
service | True | string |
The delivery service to be used. Must be one of the specified values |
|
Notification Webhook
|
webhook | string |
The webhook that should receive notifications about order updates to this order |
|
|
Single/Double Sided
|
simplex | boolean |
True if the document should be printed one page to a sheet, false if the document can be printed on both sides of a sheet |
|
|
Color/Black & White
|
color | boolean |
True if the document should be printed in color, false if the document should be printed in black and white |
|
|
Include Flat Envelope
|
flat | boolean |
True if the document MUST be mailed in a flat envelope, false if it is acceptable to mail the document folded |
|
|
Include Return Envelope
|
return_envelope | boolean |
True if the document MUST be mailed with a return envelope. Do not specify if no return envelope is needed |
|
|
Use Real Stamp
|
stamp | boolean |
True if the document MUST use a real postage stamp, false if it is acceptable to mail the document using metered postage or an imprint |
|
|
Postcard Message
|
message | string |
The message to be printed on the non-picture side of a postcard. Required if the service is set to USPS_POSTCARD |
|
|
Recipient Name
|
to.name | True | string |
The name of the recipient of this envelope or postcard |
|
Recipient Company/Organization
|
to.organization | string |
The organization or company of recipient |
|
|
Recipient Street Address
|
to.address1 | True | string |
The street number and name of the recipient |
|
Recipient Suite/Room/Floor/Unit Number
|
to.address2 | string |
The suite or room number of the recipient |
|
|
Recipient City
|
to.city | True | string |
The address city of the recipient |
|
Recipient State/Locality
|
to.state | True | string |
The address state of the recipient |
|
Recipient Postcode/Zip Code
|
to.postcode | True | string |
The postcode or zip code of the recipient |
|
Recipient Country
|
to.country | string |
The address country of the recipient |
|
|
Sender Name
|
from.name | True | string |
The name of the sender |
|
Sender Company/Organization
|
from.organization | string |
The organization or company of the sender |
|
|
Sender Street Address
|
from.address1 | True | string |
The street number and name of the sender |
|
Sender Suite/Room/Floor/Unit Number
|
from.address2 | string |
The suite or room number of the sender |
|
|
Sender City
|
from.city | True | string |
The address city of the sender |
|
Sender State/Locality
|
from.state | True | string |
The address state of the sender |
|
Sender Postcode/Zip Code
|
from.postcode | True | string |
The postcode or zip code of the sender |
|
Sender Country
|
from.country | string |
The address country of the sender |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
error.code | string |
error code |
|
message
|
error.message | string |
error message |
|
details
|
details | string |
other details |
|
success
|
success | boolean |
true on success |
|
id
|
data.id | string | |
|
lineitems
|
data.lineitems | array of object | |
|
id
|
data.lineitems.id | string | |
|
service
|
data.lineitems.service | string |