Skip to main content

Developer API Reference

Integrate InkCourier into your systems to send handwritten cards programmatically.

Authentication

All API requests require authentication using an API key. Create one in your Dashboard → API Keys.

Base URL

https://api.inkcourier.com/api/v1

Request Header

X-Api-Key: ink_YOUR_API_KEY

Security: Keep your API keys secret. Never expose them in client-side code. Rotate keys immediately if you suspect compromise.

Orders

Create and manage handwritten card orders. Orders are queued and processed automatically.

Cards

Browse available card designs. Cards are organized by category and include pricing.

Fonts (Handwriting Styles)

Browse available handwriting styles for your cards.

Addresses

Save and manage recipient and sender addresses for quick reuse.

Bulk Upload

Send multiple cards at once using CSV upload. Perfect for campaigns and batch sending.

Tip: Download the template first to see required column headers. Always validate your CSV before uploading to catch errors early.

Error Handling

All errors return a consistent JSON format with an error message and optional details.

{
  "error": "Validation failed",
  "details": {
    "recipientZip": "Invalid ZIP code format"
  }
}

HTTP Status Codes

CodeDescription
200Success
201Created successfully
400Bad request / Validation error
401Unauthorized / Invalid API key
403Forbidden / Plan limit exceeded
404Resource not found
429Rate limit exceeded
500Internal server error

Rate Limits

API requests are rate-limited to ensure fair usage and system stability.

LimitValue
Requests per 15 minutes500

Rate limit info is returned in response headers: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset

Integrations

InkCourier integrates with popular CRM and automation platforms.

Z

Zapier

Connect to 5,000+ apps

H

HubSpot

Coming soon

S

Salesforce

Coming soon

P

Pipedrive

Coming soon

Support

Need help with your integration? We're here to assist.