Ridgital Relay API

Ridgital Relay is a transactional email delivery service that enables your applications to send emails, monitor delivery status, and retrieve the complete lifecycle of every submitted message.

Getting Started

Before using the Relay API:

Create a Ridgital Relay account.
Subscribe to one of the available Relay plans.
Configure your organization.
Create an API Key from the Customer Portal.
Use the generated API Key to authenticate your requests.

Your API Key belongs to your organization and is required for every Relay API request.

Authentication

Authorization: Bearer rdg_<your_api_key

Requests without a valid API Key return 401 Unauthorized.

Base URL

https://ridgital.com/api/v1

Available Endpoints

Method	Endpoint	Description
POST	`/relay/send`	Queue a transactional email for delivery.
POST	`/relay/send/batch`	Queue up to 100 transactional emails.
GET	`/relay/messages/{message_id}`	Retrieve delivery status and lifecycle.
GET	`/relay/emails`	List submitted messages.
GET	`/relay/ping`	Validate API availability and API Key.

Asynchronous Processing

A successful response means the message has been accepted and queued, not necessarily delivered. Delivery, retries, bounce processing, tracking, and Webhook notifications occur asynchronously.

Delivery Status

canonicalStatus values:

submitted, accepted, delivered, deferred, hard_bounced, soft_bounced, suppressed, failed

delivered means the message has been accepted by your configured outbound SMTP server. Inbox placement is not guaranteed. Later DSN/Bounce reports may change the status to hard_bounced or soft_bounced.

One-Click Unsubscribe

When trackOpens or trackClicks is enabled, Relay automatically adds the RFC 8058 unsubscribe headers. One-click unsubscribe requests automatically create a Suppression record with reason unsubscribe.

ISP Feedback Loop (FBL)

Register ISP feedback loops using your own sending domain/IP. Configure the feedback mailbox to be the same as your Delivery SMTP bounce mailbox. Relay automatically processes abuse reports and creates Suppression records with reason complaint.

Security

Never expose your API Key.
Store API Keys securely.
Rotate compromised API Keys immediately.
Always use HTTPS.

Support

[email protected]

Sending

Queue one email or a batch for delivery.

Send a transactional email

POST /api/v1/relay/send

Queues an email for delivery via your configured SMTP server (set up in the Ridgital Console under Relay → SMTP Configs). Provide at least one of `html` or `text`. Attachments are base64-encoded in the JSON body; binaries are stored securely and delivered by the relay worker. Use `idempotencyKey` to safely retry without duplicate sends. Poll `GET /relay/messages/{id}` for status (`queued`, `sent_to_smtp`, `permanent_failed`, etc.). Authenticate with your API key: `Authorization: Bearer rdg_<key>`.

body (body, required): Email payload

Send up to 100 transactional emails in one request

POST /api/v1/relay/send/batch

Queues multiple emails for delivery in a single call. Each message is validated and quota-checked independently — one failing item does not block the others. Returns per-item results in request order. Authenticate with your API key: `Authorization: Bearer rdg_<key>`.

body (body, required): Batch of email payloads (max 100)

Messages

A submitted message's delivery status and lifecycle.

Get email delivery status

GET /api/v1/relay/messages/{id}

Returns the message record, lifecycle events (queued, processing, sent, bounced, failed), and attachment metadata for a message created by POST /relay/send. Use this endpoint to build delivery dashboards or confirm whether an email reached the recipient's mail server.

id (path, required): Message UUID returned by POST /relay/send

Connectivity

Check that your API key works.

Health check

GET /api/v1/relay/ping

Verifies the Relay API is reachable and your API key is valid. Call this after configuring your API key to confirm connectivity before sending production traffic.