Docs/Support/API/Email Settings & Inbound

Email Settings & Inbound API

Configure custom domain email forwarding, dedicated department inbound mailboxes, outbound SMTP/SES/SendGrid relay credentials, and ingest inbound emails via webhooks.

Outbound SMTP Relay: By default, outbound notifications are sent through the sovereign Vyntech platform cluster with SPF/DKIM validation. You can alternatively configure custom AWS SES, SendGrid, Mailgun, or private SMTP server credentials.

Fetches active email routing configuration and outbound relay settings for the workspace.

Get Email SettingsAuth

Retrieve email routing and SMTP configuration.

Status Codes

Name
200
Type
HTTP
Description
Email settings returned
Name
403
Type
HTTP
Description
Forbidden - requires Admin role

Request

GET/v1/support/email-settings

Response 200

Creates or updates workspace email forwarding addresses and outbound SMTP credentials.

Upsert Email SettingsAuth

Configure inbound forwarding address and outbound SMTP credentials for the tenant.

Payload Example

{
  "department_id": null,
  "inbound_address": "support@tenant.vyndesk.com",
  "use_platform_smtp": false,
  "outbound_config": {
    "provider": "smtp",
    "from_name": "Acme Support Team",
    "from_email": "support@acme.com",
    "settings": {
      "host": "smtp.sendgrid.net",
      "port": 587,
      "username": "apikey",
      "password": "SG.your-production-secret-key",
      "encryption": "tls"
    }
  }
}

Status Codes

Name
200
Type
HTTP
Description
Email settings configured successfully
Name
403
Type
HTTP
Description
Forbidden - requires Admin role

Request Parameters

Name
inbound_address
Type
string
Required
Description
Unique system forwarding mailbox assigned to the tenant.
Name
use_platform_smtp
Type
boolean
Description
When true, uses Vyntech managed SMTP servers; when false, uses custom outbound_config.
Name
outbound_config
Type
object
Description
Custom SMTP or SES credentials configuration dictionary.

Request

POST/v1/support/email-settings

Response 200

Webhook ingestion endpoint receiving parsed MIME messages from inbound mail providers (SendGrid, Mailgun, Postmark, AWS SES, or custom Postfix relay).

Inbound Email Webhook

Ingest incoming email payload, match threads via In-Reply-To or subject tag, and create tickets or customer replies automatically.

Payload Example

{
  "to": "support@tenant.vyndesk.com",
  "from": "customer@example.com",
  "from_name": "John Doe",
  "subject": "[Ticket #1042] Re: System login failure",
  "text": "Thank you, the SSO login issue is now resolved.",
  "html": "<p>Thank you, the SSO login issue is now resolved.</p>",
  "message_id": "<CAD+3x@mail.gmail.com>",
  "in_reply_to": "<vyn-msg-7b58c732@mail.vyntech.com>"
}

Status Codes

Name
200
Type
HTTP
Description
Email successfully parsed and attached to ticket thread
Name
201
Type
HTTP
Description
New ticket provisioned and created from inbound email
Name
400
Type
HTTP
Description
Missing recipient address or unresolvable tenant

Webhook Payload Attributes

Name
to
Type
string
Required
Description
Inbound recipient email address matching a tenant forwarding address.
Name
from
Type
string
Required
Description
Sender email address.
Name
subject
Type
string
Required
Description
Parsed email subject line.
Name
text
Type
string
Description
Plain-text decoded email body.
Name
html
Type
string
Description
Sanitized HTML email body.
Name
in_reply_to
Type
string
Description
MIME header used to correlate message with existing ticket threads.

Request

POST/v1/support/inbound-email

Response 200