Skip to content

Update email triggering docs wtih reply to #570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jhadobe wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update email triggering docs wtih reply to #570

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/pages/rest/saas-integrations/custom-email/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ The `V1/custom-email/send` endpoint allows **third-party systems**, such as inte
- **Template ID** – Email template ID.
- **Recipient email** – The target email address for this request.
- **Variables** – (Optional) Custom defined key-value pairs to inject into the template, such as `customer_name` or `order_id`.
- **Reply-To email** – (Optional) Email address to set as the `Reply-To` header so that recipient replies are routed to a specific mailbox instead of the template sender.

<InlineAlert variant="info" slots="text" />

Expand All @@ -46,12 +47,15 @@ The following section explains how to send transactional emails on demand using

If you are not using variables, pass an empty object or omit it. In the email template body and subject, use the variable syntax to reference a variable, for example `var order_id`. The subject also supports the same custom variables and syntax described in [Supported template scenarios](#supported-template-scenarios).

- **replyToEmail** (string, optional) – Email address to use for the `Reply-To` header of the outgoing email. When set, replies from the recipient are directed to this address instead of the template sender. Must be a valid email format and no longer than 255 characters. If provided, it must not be an empty string. Omit the field (or pass `null`) to use the template sender.

### Example request

```json
{
"templateId": 5,
"recipientEmail": "john@example.com",
"replyToEmail": "support@example.com",
"variables": {
"customer_name": "John",
"order_id": "100000123",
Expand All @@ -62,13 +66,14 @@ The following section explains how to send transactional emails on demand using

### Success response (HTTP 200)

The API returns HTTP 200 on successful send.
The API returns HTTP 200 on successful send. The `reply_to_email` field is only present in the response when a `replyToEmail` value was supplied in the request.

```json
{
"message": "Email accepted for delivery",
"reference_id": "a1b2c3d4e5f6-1707571800",
"recipient_email": "john@example.com",
"reply_to_email": "support@example.com",
"template_id": 5,
"template_code": "order_update_notification"
}
Expand All @@ -83,6 +88,9 @@ The API returns HTTP 200 on successful send.
- `"message": "Invalid recipient email format"` – invalid or malformed recipient address
- `"message": "Recipient email is required."` – missing or empty `recipientEmail`
- `"message": "Template ID must be a positive integer."` – missing, zero, or invalid `templateId`
- `"message": "replyToEmail must not be empty when provided."` – `replyToEmail` was supplied as an empty string
- `"message": "Invalid replyToEmail format."` – invalid or malformed `replyToEmail` address
- `"message": "replyToEmail must not exceed 255 characters."` – `replyToEmail` exceeds the 255-character limit

- **HTTP 404 – Template not found**

Expand Down
Loading