API | PostcardMe

Our RESTful API gives you programmatic access to PostcardMe's functionality, allowing you to create, customize, and send postcards directly from your own applications.

Getting Started

Base URL

https://api.postcardme.com/v1

All API requests should be made to this base URL.

Authentication

Authentication to the API is performed via HTTP Bearer Authentication. All API requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Creating a Postcard

Send a POST request to create and send a new postcard.

POST/postcards

Request Body

{
  "front_image_url": "https://example.com/image.jpg",
  "message": "Hello from Paris! The weather is beautiful.",
  "recipient": {
    "name": "John Doe",
    "address_line1": "123 Main St",
    "address_line2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country": "US"
  },
  "size": "standard",
  "shipping_level": "priority"
}

Response

{
  "id": "pcd_12345678",
  "status": "processing",
  "estimated_delivery_date": "2025-04-25",
  "tracking_url": "https://postcardme.com/track/pcd_12345678"
}

Example Request

curl -X POST https://api.postcardme.com/v1/postcards \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "front_image_url": "https://example.com/image.jpg",
    "message": "Hello from Paris! The weather is beautiful.",
    "recipient": {
      "name": "John Doe",
      "address_line1": "123 Main St",
      "address_line2": "Apt 4B",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    },
    "size": "standard",
    "shipping_level": "priority"
  }'

Rate Limits and Usage

Plan	Rate Limit	Daily Quota	Monthly Quota
Developer	10 requests/minute	500 requests	5,000 requests
Business	30 requests/minute	2,000 requests	25,000 requests
Enterprise	100 requests/minute	10,000 requests	Unlimited

Support

If you have any questions or need assistance with our API, please contact our developer support team.

API Documentation