Our REST API is easy, fast, and flexible, making it simple to integrate handwritten mailers into your applications and workflows.
Finding Your API Key
Your API key can be found in your account settings:
Log in to the Scribeless platform
Click "Settings" in the left sidebar
Navigate to the "API Keys" section
Copy your API key (format example:
M5WO4Bx5SDhttyoSvo3UGXx1Nv52$oaQLRlmnc9qFa1WFy0cg)
Security Note: Ensure you keep your API key secret to prevent unauthorized access to your account. Do not share your API key in publicly accessible areas such as GitHub, client-side code, or public forums.
Campaign Status and Workflow
When using the Scribeless API, understanding the correct campaign workflow is essential:
Pending Status for Testing
New recurring campaigns start in "Pending" status. This is specifically designed for testing your integration:
You can upload recipients against pending campaigns via API
Recipients added to pending campaigns will generate previews
These recipients will NOT be processed for printing or mailing
No charges will be incurred for recipients in pending campaigns
Use this pending status to verify your data mapping, variable replacement, and overall integration.
Activating Your Campaign
Once your testing is complete and you're satisfied with the integration:
Navigate to your campaign in the Scribeless platform
Activate the campaign to change its status from "Pending" to "Ready"
After activation, any new recipients added via API will:
Be processed for production
Be printed and mailed according to campaign settings
Be charged to your account
Important: There is no separate "testing mode" - the campaign status (Pending vs. Ready) determines whether recipients are processed or not.
API Integration
The primary endpoint for adding recipients to a campaign is:
Copy POST https://platform.scribeless.co/api/recipients
All API requests must include your API key in the X-API-Key header:
Copy X-API-Key: YOUR_API_KEY
For comprehensive documentation, including request formats, response codes, and example implementations, please refer to our Scribeless API Documentation.
Need Support?
For API integration questions or issues, reach out through our live chat or contact our support team at [email protected].
Our developer support team is available to help you successfully integrate the Scribeless API into your systems.