Intelliprint
Browse docs

Get Started

Introduction

The Intelliprint API is flexible and powerful. You can send letters and postcards, cancel them, track their status and more. The API is organised around REST.

On this page

Sending Your First Letter

  1. 1. Get an API Key

    All Intelliprint accounts can create an API key in the API Keys section of their account. API keys are displayed only once when they are created. We do not store them.

    In case you don’t already have an account, creating one is free and takes just a minute.

  2. 2. Choose an SDK

    Intelliprint maintains SDKs for the most popular programming languages. In case you didn’t find one for your language, you can refer to our OpenAPI specification and our cURL examples to build your own.

    Install an SDK

    Node.js SDK
    cURL
    npm install intelliprint

  3. 3. Send Your Letter

    Node.js SDK
    Node.js
    import Intelliprint from 'intelliprint'

const ip = new Intelliprint('your-api-key-here')

const printJob = await ip.prints.create({
  type: 'letter',
  content: 'Hello World!\nThis is a letter!',
  recipients: [{
    address: {
      name: 'John Doe',
      line: '123 Main Street, Anytown, Anyplace',
      postcode: 'AB1 2CD',
      country: 'GB'
    }
  }],
  confirmed: false // Set to 'true' when you're ready to start submitting mail for printing.
})

console.log('Print job created:', printJob.id)

    You can review the parameters available for this endpoint in the API Reference.

Switching to a Postcard

You can send postcards instead of letters by setting the type parameter to postcard.

Node.js SDK
Node.js
import Intelliprint from 'intelliprint'

const ip = new Intelliprint('your-api-key-here')

const printJob = await ip.prints.create({
  type: 'postcard', 
  content: 'Hello World!\nThis is now a postcard!',
  recipients: [{
    address: {
      name: 'John Doe',
      line: '123 Main Street, Anytown, Anyplace',
      postcode: 'AB1 2CD',
      country: 'GB'
    }
  }],
  confirmed: false // Set to 'true' when you're ready to start submitting mail for printing.
})

console.log('Print job created:', printJob.id)

Next Steps

Now that you’ve sent your first letter or postcard, it’s time to choose how you want to send items in production. For that, open the Choose a Content Strategy page to learn more.