API reference
API reference
Preview the FluxDigest REST API resources, parameters, responses, and errors.
Preview contract
These endpoints define the proposed public v1 contract. They are not the
existing dashboard routes and are not generally available yet.
Base URLs
| Environment | URL |
|---|---|
| Production | https://api.fluxdigest.com/v1 |
| Sandbox | https://api.sandbox.fluxdigest.com/v1 |
All requests use HTTPS and JSON unless an operation documents multipart data. Authenticate with a scoped key:
Authorization: Bearer fd_test_...Conventions
- Public JSON fields use
snake_case. - IDs are opaque strings.
- Timestamps are RFC 3339 UTC strings.
- Collections use cursor pagination.
- Mutations accept
Idempotency-Key. - Every response includes
X-Request-Id. - Clients must ignore unknown response fields.
Workspaces
List and retrieve workspace context.
Subscribers
Create and synchronize audience records.
Campaigns
Create campaigns and control sends.
Download the source contract from the repository at
website/openapi/fluxdigest.openapi.yaml. A downloadable bundled JSON document
will be published at /openapi.json before private beta.