mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-16 21:08:38 +08:00
13fccd32b6
Some checks failed
all-good: Did all the other checks pass? / all-good (push) Has been cancelled
Ensure Prisma migrations are in sync with the schema / check_prisma_migrations (22.x) (push) Has been cancelled
DB migration compat / Check if migrations changed (push) Has been cancelled
Docker Server Build and Push / Docker Build and Push Server (push) Has been cancelled
Docker Server Build and Run / docker (push) Has been cancelled
Runs E2E API Tests (Local Emulator) / E2E Tests (Local Emulator, Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (mock, 22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (prod, 22.x) (push) Has been cancelled
Runs E2E API Tests with custom port prefix / build (22.x) (push) Has been cancelled
Lint & build / lint_and_build (latest) (push) Has been cancelled
Dev Environment Test With Custom Base Port / restart-dev-and-test-with-custom-base-port (push) Has been cancelled
Dev Environment Test / restart-dev-and-test (push) Has been cancelled
Run setup tests with custom base port / setup-tests-with-custom-base-port (push) Has been cancelled
Run setup tests / setup-tests (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
DB migration compat / Back-compat — Current branch migrations with ${{ needs.check-migrations-changed.outputs.base_branch }} branch code (push) Has been cancelled
DB migration compat / Forward-compat — Current branch code with ${{ needs.check-migrations-changed.outputs.base_branch }} branch migrations (push) Has been cancelled
DB migration compat / No migration changes (skipped) (push) Has been cancelled
82 lines
2.1 KiB
Plaintext
82 lines
2.1 KiB
Plaintext
---
|
|
title: "Send Email"
|
|
description: "Send email to multiple users. The content field accepts HTML content, template-based configuration with variables, or a pre-existing draft identifier."
|
|
api: "POST /api/v1/emails/send-email"
|
|
---
|
|
|
|
## Request
|
|
|
|
<ParamField header="x-stack-secret-server-key" type="string" required>
|
|
The secret server key for authentication.
|
|
</ParamField>
|
|
|
|
<ParamField header="x-stack-admin-access-token" type="string">
|
|
The admin access token.
|
|
</ParamField>
|
|
|
|
<ParamField header="x-stack-project-id" type="string" required>
|
|
The project ID.
|
|
</ParamField>
|
|
|
|
<ParamField body="recipients" type="array" required>
|
|
List of recipient user IDs or email addresses.
|
|
</ParamField>
|
|
|
|
<ParamField body="subject" type="string" required>
|
|
The email subject line.
|
|
</ParamField>
|
|
|
|
<ParamField body="content" type="object" required>
|
|
The email content. Accepts one of three formats:
|
|
- **HTML:** `{ "html": "<html>...</html>" }`
|
|
- **Template:** `{ "template_id": "string", "variables": {} }`
|
|
- **Draft:** `{ "draft_id": "string" }`
|
|
</ParamField>
|
|
|
|
## Response
|
|
|
|
Returns a `200` status code on success.
|
|
|
|
<ResponseField name="success" type="boolean">
|
|
Whether the email was sent successfully.
|
|
</ResponseField>
|
|
|
|
<CodeGroup>
|
|
```bash cURL (HTML content)
|
|
curl -X POST 'https://api.stack-auth.com/api/v1/emails/send-email' \
|
|
-H 'Content-Type: application/json' \
|
|
-H 'x-stack-secret-server-key: YOUR_SECRET_SERVER_KEY' \
|
|
-H 'x-stack-project-id: YOUR_PROJECT_ID' \
|
|
-d '{
|
|
"recipients": ["usr_1234567890"],
|
|
"subject": "Welcome!",
|
|
"content": {
|
|
"html": "<h1>Welcome to our platform</h1>"
|
|
}
|
|
}'
|
|
```
|
|
|
|
```bash cURL (Template)
|
|
curl -X POST 'https://api.stack-auth.com/api/v1/emails/send-email' \
|
|
-H 'Content-Type: application/json' \
|
|
-H 'x-stack-secret-server-key: YOUR_SECRET_SERVER_KEY' \
|
|
-H 'x-stack-project-id: YOUR_PROJECT_ID' \
|
|
-d '{
|
|
"recipients": ["usr_1234567890"],
|
|
"subject": "Welcome!",
|
|
"content": {
|
|
"template_id": "welcome-email",
|
|
"variables": {
|
|
"name": "John"
|
|
}
|
|
}
|
|
}'
|
|
```
|
|
|
|
```json 200 Response
|
|
{
|
|
"success": true
|
|
}
|
|
```
|
|
</CodeGroup>
|