Skip to Content
API ReferenceIntroduction

API Reference

The Splashify Pro Email API is RESTful, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes + verbs.

Base URL

https://apis.splashifypro.com/api/v1/partner/email

All endpoints documented in this reference are relative to this base URL.

Authentication

Bearer token in the Authorization header:

Authorization: Bearer pk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

See Authentication for key generation, rotation, and rate-limit details.

Request format

POST + PATCH + PUT bodies are JSON. Set Content-Type: application/json.

Field names are snake_case. Required fields raise 400 INVALID_REQUEST when missing.

Response format

Every response is JSON. Successful responses include success: true:

{
  "success": true,
  "data": { ... }
}

Errors include a stable error code + a human-readable message:

{
  "success": false,
  "error": "FROM_NOT_VERIFIED",
  "message": "From address is not on a verified identity."
}

See Errors for the full list.

Resources

ResourceEndpoints
Emails/send, /send-raw, /send-template, /send-bulk, /emails/:id
TemplatesCRUD + preview
IdentitiesList, create, get, verify, delete
Configuration SetsCRUD + multi-tenant attribution
Event DestinationsWebhook destinations attached to config sets
SuppressionList, get, put, delete
Quotas & StatsSend quota, statistics, reputation, events
Production AccessSandbox → production lifecycle

Versioning

The API is versioned in the URL — /api/v1/. We will not introduce breaking changes within a version. New optional fields, new endpoints, and new event types may land at any time.

If we ever ship /api/v2/, we’ll keep /api/v1/ operational for at least 12 months and announce the deprecation timeline at least 90 days in advance.

Idempotency

Send endpoints are NOT idempotent — duplicate calls produce duplicate sends. Implement application-level dedup against your business identifier (charge_id, signup_id, etc.) before calling /send.

Idempotency-key support via Idempotency-Key header is on the roadmap.

SMTP RelayPagination