SendPromptly API Documentation

The SendPromptly API provides endpoints for managing subscribers and automating email campaigns with advanced scheduling features.

Base URL: https://app.sendpromptly.com

Authentication

All API endpoints require authentication using an Email Message API Key in the header:

X-Email-Message-API-Key: your_api_key_here

You can find your API key in your SendPromptly dashboard under Project → Messages → API Key.

Email Scheduling

SendPromptly’s unique email scheduling feature allows you to automatically send emails when subscribers are added:

  • schedule_message (boolean, default: true) - Whether to schedule the email
  • delay_value (integer, default: 0) - Delay in hours before sending

Quick Start

1. Create a Subscriber with Email Scheduling

curl -X POST https://app.sendpromptly.com/api/subscribers \
  -H "X-Email-Message-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "schedule_message": true,
    "delay_value": 24
  }'

2. List Subscribers

curl -X GET https://app.sendpromptly.com/api/subscribers \
  -H "X-Email-Message-API-Key: your_api_key"

API Endpoints

Response Format

All API responses follow this consistent format:

Success Response:

{
  "success": true,
  "message": "Operation completed successfully",
  "data": { /* resource data */ }
}

Error Response:

{
  "success": false,
  "message": "Error description",
  "errors": { /* validation errors if applicable */ }
}

Rate Limits

API rate limits are based on your subscription plan:

  • Free Plan: 60 requests per minute
  • Standard Plan: 300 requests per minute
  • Premium Plan: 600 requests per minute

Rate limit headers are included in each response:

X-RateLimit-Limit: <max requests per minute>
X-RateLimit-Remaining: <requests remaining in current window>
X-RateLimit-Reset: <seconds until window resets, only when limit is reached>

For detailed information about rate limiting, please see our Rate Limiting Documentation.

Additional limits:

  • Bulk operations: Maximum 1000 records per request

Need Help?