Skip to main content

Overview

Rewrite API v1 exposes public project endpoints for sending SMS, verifying OTPs, managing templates and webhooks, and reading request logs and webhook deliveries.

Base URL

All public endpoints live under:

Authentication

Public routes use your API key:

Request conventions

  • Use Content-Type: application/json on non-GET requests.
  • Public send and OTP flows accept either a direct E.164 number in to or a saved project contact in contact.
  • Message creation uses content for inline SMS bodies.
  • Template-backed sends use templateId plus variables.
  • Message and template metadata are key/value objects, not arrays of pairs.
  • Create/send routes support Idempotency-Key.
Example request:

Response conventions

Successful responses use the ok / data envelope:
Paginated list routes return a top-level cursor.

Public event model

  • Delivery lifecycle now includes message.delivered.
  • Inbound traffic is represented by message.received.
  • Webhook deliveries are documented under Deliveries, including GET /deliveries and GET /webhooks/{id}/deliveries.

References