Skip to main content
A comprehensive reference of terms used throughout the Intelliprint API documentation.

A

Address Validation

Service that verifies postal addresses are valid and deliverable before sending mail. Helps reduce returned mail and delivery failures. Learn more about address validation →

API Key

Secret credential used to authenticate API requests. Generate keys in your dashboard.
Keep API keys secure. Never commit them to version control or share them publicly.

B

Background

A reusable letterhead or design template that can be applied to multiple print jobs. Useful for company branding, logos, and headers/footers. Learn more about backgrounds →

Base64

Encoding scheme for representing binary data (like PDFs or images) as text. Used when uploading files inline in JSON requests.
const base64PDF = Buffer.from(pdfBytes).toString('base64');

C

Confirmed Print Job

A print job with confirmed: true that has been submitted for printing. Confirmed jobs cannot be edited or cancelled once in production.
confirmed: true  // Job will be printed and sent

Coversheet

A separate page with the recipient’s address, automatically added to PDFs that don’t have addresses embedded. Also called an “address sheet”. Learn more about coversheets →

D

Double-Sided Printing

Printing on both sides of paper to reduce the number of sheets used, saving costs. Also known as “duplex printing”.
printing: {
  double_sided: 'yes'  // Reduces sheets by ~50%
}
Learn more about double-sided printing →

Draft Print Job

A print job with confirmed: false that can still be edited, previewed, or cancelled. Drafts are not printed until confirmed.
confirmed: false  // Job can still be edited

E

Envelope

The physical envelope used to send letters. Intelliprint offers multiple sizes (C5, C4, C4+, A4 Box) depending on document thickness. Learn more about envelopes →

Extra Documents

Additional PDFs included with a letter, such as brochures, T&Cs, or forms. Intelliprint prints these for you. Learn more about extra documents →

F

First Class

Royal Mail service with 1-2 business day delivery. Costs more than Second Class but delivers faster.
postage: {
  service: 'first_class'
}

I

Idempotency

Mechanism to safely retry API requests without creating duplicate resources. Use idempotency keys to ensure a request is only processed once, even if sent multiple times.
headers: {
  'Idempotency-Key': 'unique-key-123'
}

Insert

Pre-printed material (like business cards, vouchers, or samples) that Intelliprint stores and automatically includes in your mailings. Contact support to enable. Learn more about inserts →

L

Letter

Standard mail item sent in an envelope. Can contain multiple pages, backgrounds, and extra documents.

Live Mode

Production mode where print jobs are charged to your account and physically sent. Opposite of test mode.
testmode: false  // or omit testmode entirely

M

Mailing List

A stored collection of recipients with addresses and custom variables. Reusable for multiple campaigns. Learn more about mailing lists →

Mailing List Recipient

An individual contact within a mailing list, containing an address and optional variables for personalisation.
{
  address: { name: 'John Doe', /* ... */ },
  variables: { first_name: 'John', discount: '20%' }
}

Metadata

Arbitrary key-value data you can attach to print jobs for your own tracking and organisation. Not visible to recipients.
metadata: {
  customer_id: '12345',
  campaign: 'Q1-2025'
}

P

Postcard

Mail format without an envelope. Available in A5 and A6 sizes. Always in colour. Learn more about postcards →

Postage Service

Royal Mail delivery service used for your mailings, such as uk_second_class, uk_first_class, uk_second_class_signed_for, uk_first_class_signed_for, uk_special_delivery, tracked_24, tracked_48, and international. Learn more about postage → The core API object representing one or more letters or postcards to be sent. Each print job has a unique ID (e.g., print_abc123).
const printJob = await ip.prints.create({/* ... */});
console.log(printJob.id);  // print_abc123

R

Rate Limit

Maximum number of API requests allowed per second. Helps ensure reliable service for all customers. Learn more about rate limits →

Recipient

A person or business who will receive mail. Contains an address and optional variables.
recipients: [{
  address: {
    name: 'John Doe',
    line: '123 Main St, London',
    postcode: 'SW1A 1AA',
    country: 'GB'
  },
  variables: { first_name: 'John' }
}]

Royal Mail

The UK postal service that delivers all Intelliprint mail items.

S

Scheduling

Setting a future date for mail to be sent. Useful for timed campaigns or reminders.
dispatch_date: '2025-12-25'  // Send on Christmas Day
Learn more about scheduling →

Second Class

Royal Mail service with 2-3 business day delivery. More economical than First Class.
postage: {
  service: 'second_class'  // Default
}

Sheet

One physical piece of paper. A letter with 4 pages printed double-sided uses 2 sheets. Pricing is based on sheets, not pages.

Signed For

Royal Mail service requiring a signature on delivery. Provides proof of delivery via a delivery scan and signature but does not include full end-to-end tracking updates. Common API values:
postage: {
  service: 'uk_first_class_signed_for'   // or 'uk_second_class_signed_for'
}

Splitting

Dividing a single PDF into multiple letters. Methods include split_on_phrase, split_on_pages, mailing_list, or none. Learn more about splitting →

T

Template

HTML or PDF design created in the dashboard with variable placeholders like {first_name}. Variables are automatically replaced for each recipient.
<h1>Dear {first_name},</h1>
<p>Your balance is {balance}.</p>
Learn more about templates →

Test Mode

Development mode where requests don’t charge your account and mail is not physically sent. PDFs are still generated for preview.
testmode: true  // No charges, no physical sending
Always test first! Use test mode to preview and verify your mail before sending it live.
Learn more about test mode →

Tracked

Generic term for postage services that provide tracking updates during a mail item’s journey, such as uk_special_delivery, uk_special_delivery_9am, tracked_24, and tracked_48.
Signed For services provide a delivery scan and signature only (proof of delivery), not full in-transit tracking.

V

Variable

Dynamic data field in templates that gets replaced with actual values for each recipient.
// In template:
'Dear {first_name},'

// Gets replaced with:
'Dear John,'
Variables work with dashboard templates, not inline HTML content. Learn more about variables →

W

Webhook

HTTP callback that notifies your server when events occur (e.g., letter status updated, mailing list validated). Configure webhooks at account.intelliprint.net/api_keys. Learn more about webhooks →

Still have questions?