This request will create a letter and perform a mail merge to put the address and any variable data in place. You can specify a template or provide the content directly.
| Parameter | Details | Description |
|---|---|---|
| test | body bool optional | If set to true, a sample PDF file will be produced but the item will not be dispatched and no charge will be taken. |
| recipient | body object required | Either an ID of an existing recipient or a new recipient array. |
| template | body int optional | An ID of a template already set up on the platform. |
| file | body file optional | Alternatively to using the template or pages parameters, you can send a PDF/DOC file directly. Maximum of 64 pages. |
| duplex | body bool optional | Set to false if you only want to print on the front of each page. Defaults to true. |
| clearzone | body bool optional | If true, we will overlay clear zones with a white background. Defaults to false. |
| post_unverified | body bool optional | Default is true. If set to false, we will not post the item if the recipient address could not be verified. |
| tags | body str optional | Comma-separated tags for your reference which you can search by in reporting. |
| addons | body str optional | Use addon codes to upgrade your letter, e.g., FIRST_CLASS to send your letter using first-class postage. |
curl -X POST "https://api-eu1.stannp.com/v1/letters/create" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"test": true,
"file": "https://www.stannp.com/assets/samples/letter-heading.pdf",
"recipient": {
"title": "Mr",
"firstname": "John",
"lastname": "Smith",
"address1": "123 Sample Street",
"address2": "Sampleland",
"town": "Sampletown",
"postcode": "AB12 3CD",
"country": "GB"
},
"tags": "used.for.reporting",
"addons": "first_class"
}'
{
"success": true,
"data": {
"pdf": "https://www.stannp.com/assets/samples/letter-sample-12345-12345-abcdeg.pdf",
"id": "0",
"created": "2022-10-01T15:42:22+00:00",
"format": "us-letter",
"cost": "0.76",
"status": "test"
}
}Post a single letter that already has an address on the PDF file. Use this endpoint if you have already mail-merged your letter and it meets our design guidelines.
| Parameter | Details | Description |
|---|---|---|
| test | body bool optional | If set to true, a sample PDF file will be produced but the item will not be dispatched and no charge will be taken. |
| country | body str required | ISO alpha-2 country code, e.g., US, CA, GB, FR, DE. |
| file | body file optional | A URL or binary file of the PDF file to print and post. |
| duplex | body bool optional | Defaults to true. |
| transactional | body bool optional | Use this for sensitive data. Defaults to false. |
| tags | body str optional | Comma-separated tags for your reference which you can search by in reporting. |
curl -X POST "https://api-eu1.stannp.com/v1/letters/post" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"test": true,
"country": "GB",
"file": "https://www.stannp.com/assets/samples/letter-sample-abcdefg-12356.pdf"
}'
{
"success": true,
"data": {
"pdf": "https://www.stannp.com/assets/samples/letter-sample.pdf",
"id": "0",
"created": "2022-12-01T15:42:22+00:00",
"format": "letter",
"cost": "0.78",
"status": "test"
}
}Obtain the mailpiece object for the letter ID specified.
| Parameter | Details | Description |
|---|---|---|
| id | path int required | The ID of the letter to retrieve. |
curl -X GET "https://api-eu1.stannp.com/v1/letters/get/16818210" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"success": true,
"data": {
"id": "16818210",
"timestamp": "2019-02-13 00:14:04",
"status": "cancelled",
"type": "letter",
"format": "A4",
"pdf_file": "https://api-eu1.stannp.com/v1/storage/get/port/1550016843/pdfs/15500168437775c63614bd88b1-d26cc45469-A4-K5aZSp.pdf",
"country": "GB",
"cost": "0.00"
}
}Cancel a letter if it has not started processing yet.
| Parameter | Details | Description |
|---|---|---|
| id | body int required | The ID of the mailpiece item. |
curl -X POST "https://api-eu1.stannp.com/v1/letters/cancel" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "12345"
}'
{
"success": true
}