Getting Started

The Postscript API lets you track customer events, manage profiles, and power SMS marketing automations for your e-commerce store.

Base URL

https://api.postscript.io/v1

Quick Start

1. Get an API key — Create one in your Postscript dashboard under Settings → API Keys.
2. Send your first event — Track a customer action:

curl -X POST https://api.postscript.io/v1/events \
  -H "Authorization: Bearer ps_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "event_type": "placed_order",
    "profile": {
      "email": "[email protected]"
    },
    "properties": {
      "order_id": "ORD-1234",
      "value": 99.99,
      "currency": "USD"
    }
  }'

3. Create a profile — Or use the upsert endpoint for create-or-update behavior:

curl -X POST https://api.postscript.io/v1/profiles/upsert \
  -H "Authorization: Bearer ps_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "identifiers": {
      "email": "[email protected]"
    },
    "attributes": {
      "first_name": "Jane",
      "loyalty_tier": "gold"
    }
  }'

API Surfaces

Postscript provides two API formats from the same service:

This documentation covers the Native API. Both surfaces share the same authentication, rate limiting, and business logic.

Resources

• Authentication — API key format and scopes
• Rate Limiting — Request limits and headers
• Error Handling — Error format and codes
• Web SDK — Browser-side event tracking
• API Reference — Complete endpoint reference