JSON Letter API
Our JSON Letter API is a RESTful API and enables you to use the same methods as our SOAP API but without the overhead of setting up a SOAP call to send letters via our service.
To see an example of using our JSON interface visit the following link
A list of the fields and their usage can be seen below.
| Field | Description |
|---|---|
| SourceClient | This is the name of your application so we can identify it if we find any problems |
| Addresses | This is an array of addresses you would like to send the letter to |
| ReceiverCountryCode | This is the country code you will be sending your letter to. You can look these up here |
| Postage | This is the postage zone you would like your letter to be sent from, such as UK first class or UK second class. You can look these up on our postage calculator or by using our letter pricing API |
| Paper | This is the Paper type you would like your letter printed on. You can look these up on our postage calculator or by using our letter pricing API |
| Envelope | The envelope your letter is to be sent in. You can look these up on our postage calculator or by using our letter pricing API |
| Extras | This is for extras such as Recorded Mail. You can look these up on our postage calculator or by using our letter pricing API |
| LetterBody | This is where you can write your letter. It can be formated HTMl or left blank if you would rather just attach a PDF to your letter. You can also have both options at once. |
| IncludeSenderAddressOnEnvelope | If you have included a sender address (return address) this tells the site that you wish to have this placed on the enevelope |
| SenderAddress | This is your return address. Each line can be seperated by a line break |
| CustomerOwnId |
This is your own reference number that be used for your own tracking purposes or admin. Perhaps from you rown CRM system. |
Address Fields
| Field | Description |
|---|---|
| ReceiverName | Who the letter is to |
| ReceiverAddressLine1 | The first line of the address |
| ReceiverAddressLine2 | The second line of the address |
| ReceiverAddressTownCityOrLine3 | The town or city |
| ReceiverAddressCountyStateOrLine4 | The county or state |
| ReceiverAddressPostCode | The postcode or zip code |
