Getting Started

Introduction

Learn what the Scribeless API is for.

The Scribeless API lets you create campaigns, add recipients, render handwriting assets, and create custom HTML mail pieces from your own systems.

Use it when you need to:

Create a campaign.
Add one or more recipients to a campaign.
Pass recipient address fields and custom variables into a campaign.
Render handwriting as a PNG.
Create a custom HTML recipient when your system generates the mail-piece artwork.
Receive webhook events when a generated Smart QR code is scanned.

Before you start

Sign in to platform.scribeless.co.
Set up your team.
Create an API key in Settings > API keys.
For standard recipient creation, create the Scribeless campaign you want to send recipients to, then use its campaign ID.
For custom HTML recipients, choose the product_key for the mail format.
Include your API key with each request.

https://platform.scribeless.co/api

Authentication

Authenticate Scribeless API requests with X-API-Key.