MailDash API

This is the basic API documentation for the MailDash API. There are 2 main API methods and a method for posting events. This document will give you the basic integration details that you can use to connect to this system.

Learn more »

LetterCreate

This method will create a letter and return a JSON object.

Details

HTTP Method

Get

Parameters

Key Your private key (Required)
Method LetterCreate (Required)
LetterID Your system's LetterID (Required)
CustomerID Your system's CustomerID
CompanyID Your system's CompanyID
CompanyName The company that is sending this letter
LastName The customer's last name
To-Name The name of the person or company this letter is being sent to (Required)
To-Address1 The to address (Required)
To-Address2 The 2nd line of the to address
To-City The to address city (Required)
To-State The 2 LETTER to address state (Required)
To-PostalCode The to address postal code (Required)
From-Name The name of the person or company this letter is being sent from (Required)
From-Address1 The from address (Required)
From-Address2 The 2nd line of the from address
From-City The from address city (Required)
From-State The 2 LETTER from address state (Required)
From-PostalCode The from address postal code (Required)
SourceFile This is the URL of the PDF file you're mailing OR base64 encoded PDF file (Required)
MailType "firstclass", "certified" or "certified_sig" only (Required)

Sample Call

https://maildash.io/process.aspx?Key=[Private Key]&Method=LetterCreate&LetterID=3131313&CustomerID=123123& CompanyID=1234&CompanyName=Test Company&LastName=Garcia&To-Name=Google&To-Address1=1600 Amphitheatre Parkway&To-City=Mountain View& To-State=CA&To-PostalCode=94043&From-Name=Apple Inc&From-Address1=1 Apple Park Way&From-City=Cupertino&From-State=CA&From-PostalCode=95014& SourceFile=https://www.africau.edu/images/default/sample.pdf&MailType=firstclass

Returns

{
  "Success": "True",
  "MailingID": "ltr_9b02df1c047623f5",
  "ExpectedDeliveryDate": "2022-10-04"
}

LetterGet

This method will return a JSON object with details about a letter based on it's ID.

Details

HTTP Method

Get

Parameters

Key Your private key (Required)
Method LetterGet (Required)
MailingID The ID of the mail (Required)

Sample Call

https://maildash.io/process.aspx?Key=[Private Key]&Method=LetterGet&MailingID=123123

Returns

{
  "MailingID": "ltr_31e0a6f7de5c6076",
  "TrackingNumber": null,
  "To-Name": "Larry Lobster",
  "To-Address1": "PO BOX 123123123",
  "To-Address2": "",
  "To-City": "Tampa",
  "To-State": "FL",
  "To-PostalCode": "33333",
  "From-Name": "THOMAS THE TRAIN",
  "From-Address1": "1235 Testing Ave",
  "From-Address2": "",
  "From-City": "Tampa",
  "From-State": "FL",
  "From-PostalCode": "33333",
  "MailType": "firstclass",
  "CustomerID": "4341192",
  "CompanyID": "4469",
  "TrackingEvents": [
    {
      "Name": "Mailed",
      "DateTime": "07/15/2023 06:12:44"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/14/2023 20:30:30"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/15/2023 15:08:40"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/15/2023 16:11:07"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/17/2023 23:13:03"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/18/2023 08:08:52"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/18/2023 10:08:56"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/18/2023 10:13:11"
    },
    {
      "Name": "In Local Area",
      "DateTime": "07/18/2023 20:36:56"
    },
    {
      "Name": "Processed for Delivery",
      "DateTime": "07/19/2023 08:08:23"
    }
  ],
  "TrackingEntries": 10
}

Webhook

Our mailhouse system can send a webhook call for each letter event. Please first let us know which URL to call. Note that this is a simple HTTP Post upon each and every event. The webhook will send a JSON object with details about a letter and the event.

Sample Post

https://yourwebhookurl/

HTTP Post Body

json={
  "MailingID": "ltr_31e0a6f7de5c6076",
  "TrackingNumber": null,
  "To-Name": "Larry Lobster",
  "To-Address1": "PO BOX 123123123",
  "To-Address2": "",
  "To-City": "Tampa",
  "To-State": "FL",
  "To-PostalCode": "33333",
  "From-Name": "THOMAS THE TRAIN",
  "From-Address1": "1235 Testing Ave",
  "From-Address2": "",
  "From-City": "Tampa",
  "From-State": "FL",
  "From-PostalCode": "33333",
  "MailType": "firstclass",
  "CustomerID": "4341192",
  "CompanyID": "4469",
  "TrackingEvent": "Processed for Delivery",
  "TrackingDate": "07/19/2023 08:08:23",
  "TrackingEvents": [
    {
      "Name": "Mailed",
      "DateTime": "07/15/2023 06:12:44"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/14/2023 20:30:30"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/15/2023 15:08:40"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/15/2023 16:11:07"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/17/2023 23:13:03"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/18/2023 08:08:52"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/18/2023 10:08:56"
    },
    {
      "Name": "In Transit",
      "DateTime": "07/18/2023 10:13:11"
    },
    {
      "Name": "In Local Area",
      "DateTime": "07/18/2023 20:36:56"
    },
    {
      "Name": "Processed for Delivery",
      "DateTime": "07/19/2023 08:08:23"
    }
  ],
  "TrackingEntries": 10
}

LettersPost

This method will post letters to MailDash for customer self-fulfillment and return a JSON object. This method should be used to send files to MailDash and to alert a customer that they are ready to print.

Details

HTTP Method

POST

Parameters

Key Your private key (Required)
Method LettersPost (Required)
sender_id Customer id from 3rd party (Required)
sender_email Customer email address (Required)
sender_phone Customer mobile phone number (Not required)
sender_firstname Customer first name (Required)
sender_lastname Customer last name (Required)
sender_address1 Customer address line 1 (Required)
sender_address2 Customer address line 2
sender_city Customer city (Required)
sender_state Customer 2 letter state (Required)
sender_zip Customer zip code (Required)
sender_provider Customer provider code (Required)
include_emailalerts Will send email alerts for letter status updates
include_smsalerts Will send SMS alerts for letter status updates
mailtype Choose from firstclass, standard, certified or certified_sig (OPTIONAL)
files JSON collection of files (Required)

Sample Call

https://maildash.io/process.aspx

HTTP Post Body

Key=[Private Key]&
Method=LettersPost&
sender_email=test@testemailaddress.com&
sender_firstname=Billy Bob&
sender_lastname=Thorton&
sender_address1=123 Test St&
sender_address2=Unit 1&
sender_city=Tampa&
sender_state=FL&
sender_zip=33604&
sender_provider=xxxxx
files=[
	{
		"name":"test_letter1.pdf",
		"contents":"JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9U...."
	},
{
		"name":"test_letter2.pdf",
		"contents":"JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9U...."
	}
]

Returns

{
  "Success": "True",
  "LeadID": "123",
  "OrderID": "123"
}

LetterDelete

This method will delete a letter which has been sent to MailDash, by receipient name. This method should be used to delete files that should no longer be included in a MailDash order.

Details

HTTP Method

POST

Parameters

Key Your private key (Required)
Method LetterDelete (Required)
OrderID Order id from MailDash (Required)
Recipient Recipient name (Required)

Sample Call

https://maildash.io/process.aspx

HTTP Post Body

Key=[Private Key]&
Method=LetterDelete&
OrderID=1234&
Recipient=Billy Bob

Returns

{
  "Success": "True",
  "Message": "1 file deleted",
  "Deleted": "1",
}

Error Handling

Errors are returned as a simple JSON object with Success=False and a general message. Please contact us for extra support.

Example

{"Success":"False","Message":"Letter Not Found"}