Base URL
/api/v1 prefix, except a few root-mounted assets: the tracking pixel (/o.gif), click redirect (/c), storefront bundle (/storefront/senderz.js), push service worker (/storefront/push-sw.js) and the embedded-form bundle (/forms/senderz-form.js).
Versioning
The API version is2026-01, returned by GET /public/me. New behaviour is added compatibly.
The response envelope
Every successful response is wrapped:data. Errors use success: false — see Errors.
The surfaces
Authentication
The
X-Sender-Tenant + X-API-Key header pair.Profiles
Create, upsert, update, look up and blacklist contacts.
Lists
List segments and manage static list membership.
Messages
Send transactional email and SMS.
Events
Ingest custom events to trigger flows.
Webhooks
Subscribe to outbound events.

