OVEYON API
API by Oveyon · rest
Transactional email infrastructure with both directions over HTTP. API-key (Bearer) authentication with scopes; errors with a stable error and a localized message — including what is refused before the route runs: invalid_json (400), request_too_complex (400, the body structure: lists, values, nesting), payload_too_large (413, with the route limit), unsupported_media_type (415), internal_error (500, the detail never leaves our logs) and not_found for a route that does not exist; 429 with Retry-After; sandbox with X-Oveyon-Sandbox: 1; idempotency with Idempotency-Key. Webhooks signed with HMAC-SHA256 (see webhooks). LANGUAGE OF HUMAN-READABLE TEXT: like message, every field that is a sentence for a person follows the caller — Portuguese when the request comes from Brazil (Cloudflare CF-IPCountry), English for everyone else, including when the country is unknown: detail of inbound deliveries and of agent-safety signals, label of the /v1/stats breakdown,…
Endpoint: https://api.oveyon.com/v1
Verification: observed. Source: crawl.
Capabilities (119)
- List campaigns
- Create a campaign (draft)
- Get a campaign with its content
- Edit a campaign
- Delete a campaign
- Turn on the recurrence of a weekly model
- Approve a campaign (it does NOT send)
- Cancel a campaign
- Check a campaign: its problems its audience the brand’s readiness and the…
- Pause a running campaign
- Send a preview of the campaign to a user of the account
- Rehearse a campaign (everything except sending)
- The report of a campaign
- Resume a paused campaign
- Schedule a campaign — the gesture that sends
- List contacts
- Create or update a contact (upsert by email)
- Delete a contact
- Find a contact by email with its tags and lists
- Register a contact property with an explicit type
- Add tags to a contact
- Remove tags from a contact
- List CIDRs per credential
- Allow a CIDR for a credential
- Pause a credential’s IP fence