---
title: "Create an email account"
method: POST
path: "/v3/email-accounts"
tags: ["Email Accounts"]
---

# Create an email account

`POST /v3/email-accounts`

<small>_Requires the `channels:write` scope (or a broader one that includes it)._</small>

Creates a new email account. Only works with custom email account providers (SMTP/IMAP).

## Request body

- object — Request body for creating a new custom email account (SMTP/IMAP).
  - `connection` object, required — SMTP and IMAP connection settings for a custom email account. Only applicable to Custom provider type.
    - `email` string, email, required — The email address
    - `senderName` string — The name displayed as sender in recipient inboxes
    - `smtpHost` string, required — Hostname or IP address of the SMTP server used for sending emails
    - `smtpPort` integer, required — Port number for the SMTP server (typically 465 for SSL/TLS)
    - `smtpPassword` string, required — Password for SMTP authentication
    - `smtpSsl` boolean — Whether SSL/TLS is used for the SMTP connection
    - `imapHost` string, required — Hostname or IP address of the IMAP server used for receiving emails
    - `imapPort` integer, required — Port number for the IMAP server (typically 993 for SSL/TLS)
    - `imapPassword` string, required — Password for IMAP authentication
    - `imapSsl` boolean — Whether SSL/TLS is used for the IMAP connection
  - `safety` object — Sending safety and throttling configuration.
    - `dailyLimit` integer — Maximum number of emails that can be sent per day
    - `isEmailsThrottlingEnabled` boolean, nullable — Whether email throttling is enabled
    - `emailsPerInterval` integer, nullable — Number of emails allowed per throttling interval
    - `emailsThrottlingSecondsInterval` integer, nullable — Length of the throttling interval in seconds
    - `isSendingDelayEnabled` boolean, nullable — Whether a random delay between emails is enabled
    - `maxSendingDelaySeconds` integer, nullable — Maximum delay in seconds between sent emails
    - `minSendingDelaySeconds` integer, nullable — Minimum delay in seconds between sent emails
  - `signature` object — Email signature configuration.
    - `signature` string, nullable — HTML or plain-text signature appended to outgoing emails
  - `optOut` object — Opt-out / unsubscribe link configuration.
    - `message` string, nullable — Opt-out message text
    - `emailFooter` string, nullable — Footer text appended to emails
    - `isOptOutLinkEnabled` boolean — Whether the opt-out link is included in emails
    - `optOutTextBlock` string, nullable — Custom opt-out text block content
  - `rampUp` object — Sending volume ramp-up configuration for warming up email accounts.
    - `enabled` boolean — Whether sending ramp-up is enabled
    - `startValue` integer — Initial number of emails per day when ramp-up starts
    - `incrementValue` integer — Daily increase in email volume during ramp-up
  - `tags` string[] — Tag names to assign to the new email account

## Response `201`

Email account created successfully

- object — Full detailed representation of an email account, including all configuration sections.
  - `id` integer — Unique identifier for the email account
  - `ownerUserId` integer — ID of the user who owns this email account
  - `emailAccountType` 'custom' | 'gmail' | 'outlook' | 'exchange' | 'exchangeOnPremise' — Provider type of the email account. Values: custom, gmail, outlook, exchange, exchangeOnPremise
  - `isDefault` boolean — Whether this is the user's default email account
  - `isInUse` boolean — Whether this email account is currently used in any active sequence
  - `connectionStatus` 'unknown' | 'connected' | 'disconnected' — Current connection status of the email account. Values: unknown, connected, disconnected
  - `sendingConnectivityError` string, nullable — Error details if SMTP sending connectivity has failed
  - `receivingConnectivityError` string, nullable — Error details if IMAP receiving connectivity has failed
  - `sendingLockedByProvider` boolean — Whether the email provider has locked outbound sending
  - `updatedAt` string, date-time — Timestamp of the last update to this email account
  - `connection` object — Connection settings returned in responses (passwords excluded).
    - `email` string, email — The email address
    - `senderName` string — The name displayed as sender in recipient inboxes
    - `smtpHost` string — Hostname or IP address of the SMTP server
    - `smtpPort` integer — Port number for the SMTP server
    - `smtpSsl` boolean — Whether SSL/TLS is used for the SMTP connection
    - `imapHost` string — Hostname or IP address of the IMAP server
    - `imapPort` integer — Port number for the IMAP server
    - `imapSsl` boolean — Whether SSL/TLS is used for the IMAP connection
  - `safety` object — Sending safety and throttling configuration.
    - `dailyLimit` integer — Maximum number of emails that can be sent per day
    - `isEmailsThrottlingEnabled` boolean, nullable — Whether email throttling is enabled
    - `emailsPerInterval` integer, nullable — Number of emails allowed per throttling interval
    - `emailsThrottlingSecondsInterval` integer, nullable — Length of the throttling interval in seconds
    - `isSendingDelayEnabled` boolean, nullable — Whether a random delay between emails is enabled
    - `maxSendingDelaySeconds` integer, nullable — Maximum delay in seconds between sent emails
    - `minSendingDelaySeconds` integer, nullable — Minimum delay in seconds between sent emails
  - `signature` object — Email signature configuration.
    - `signature` string, nullable — HTML or plain-text signature appended to outgoing emails
  - `optOut` object — Opt-out / unsubscribe link configuration.
    - `message` string, nullable — Opt-out message text
    - `emailFooter` string, nullable — Footer text appended to emails
    - `isOptOutLinkEnabled` boolean — Whether the opt-out link is included in emails
    - `optOutTextBlock` string, nullable — Custom opt-out text block content
  - `rampUp` object — Sending volume ramp-up configuration for warming up email accounts.
    - `enabled` boolean — Whether sending ramp-up is enabled
    - `startValue` integer — Initial number of emails per day when ramp-up starts
    - `incrementValue` integer — Daily increase in email volume during ramp-up
  - `tags` string[] — Tag names associated with this email account

## Other responses

- `400` — Validation failure on the request body, or a business rule rejection (e.g. invalid input on a domain field).
- `401` — Unauthorized. The response body is empty; check the `WWW-Authenticate` header for the expected scheme.
- `403` — User lacks required feature scope to create email accounts
- `409` — Email account limit reached for the plan
- `429` — Too Many Requests

---

[API](https://skmtc.net/reply/apis/reply-api.md) · [All operations](https://skmtc.net/reply/apis/reply-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reply/reply-api/versions/1c3d32eaf95e/schema)
