Provision New Sender

{
  "name": "Global Support Desk",
  "email": "support@yourdomain.com",
  "provider": "stalwart",
  "from_name": "Syntr Support",
  "reply_to_email": "tickets@yourdomain.com",
  "verified_domain_id": "b7e1-9283-acde-4912-8839"
}

{
  "success": true,
  "data": {
    "id": "b7e1-acde",
    "tracking_id": "verify_seq_8872"
  }
}

POST

sender-emails

{
  "name": "Global Support Desk",
  "email": "support@yourdomain.com",
  "provider": "stalwart",
  "from_name": "Syntr Support",
  "reply_to_email": "tickets@yourdomain.com",
  "verified_domain_id": "b7e1-9283-acde-4912-8839"
}

{
  "success": true,
  "data": {
    "id": "b7e1-acde",
    "tracking_id": "verify_seq_8872"
  }
}

Request Body

string

required

Internal label for the sender

string

required

The ‘from’ email address

string

required

Provider type (stalwart, gmail_oauth)

string

Display name in recipients’ inbox

string

Address for replies

string

Required for ‘stalwart’ provider

{
  "name": "Global Support Desk",
  "email": "support@yourdomain.com",
  "provider": "stalwart",
  "from_name": "Syntr Support",
  "reply_to_email": "tickets@yourdomain.com",
  "verified_domain_id": "b7e1-9283-acde-4912-8839"
}

{
  "success": true,
  "data": {
    "id": "b7e1-acde",
    "tracking_id": "verify_seq_8872"
  }
}

Connection Guide

Different providers follow distinct setup flows. Follow the instructions below depending on your provider choice:

Stalwart Mail
Gmail Workspace (OAuth)

Stalwart senders are provisioned directly using this POST endpoint.

First, add and verify your custom domain in the Domain Setup interface (DNS verification).
Retrieve the verified_domain_id (UUID) for your verified domain.
Make a POST request to /sender-emails with:
- provider: "stalwart"
- verified_domain_id: The domain UUID.
- email: The desired email address matching the domain (e.g. support@yourdomain.com).

Gmail Workspace senders cannot be provisioned directly via this POST endpoint. Instead, they must be connected using the web-based Google OAuth flow:

Initiate the OAuth flow by redirecting the user to:

GET /api/v1/auth/google/gmail?returnUrl={YOUR_DASHBOARD_URL}

Once the user completes Google Workspace authentication, Google redirects back to the platform callback, which automatically registers/creates the sender email with provider: "gmail_oauth".

Overview

Senders

Campaigns

Audience & Lists

Templates

Univox Inbox

Transactional API

Provision New Sender

Request Body

Connection Guide

​Request Body

​Connection Guide

Request Body

Connection Guide