コンテンツにスキップ
Authrim

Send email to user

POST
/api/admin/users/{id}/send-email
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/users/example/send-email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "template": "security_alert", "subject": "Suspicious sign-in detected", "variables": { "ip": "203.0.113.10", "time": "2026-06-01T00:00:00.000Z" } }'

Queues a templated email job for the user when the user has an email address.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”

Email template and template variables to enqueue for a user.

Media type application/json
object
template
required
string
Allowed values: password_reset welcome verification notification security_alert account_locked account_suspended
subject
string
variables
object
key
additional properties
string
key
additional properties
Example 
{
  "template": "security_alert",
  "subject": "Suspicious sign-in detected",
  "variables": {
    "ip": "203.0.113.10",
    "time": "2026-06-01T00:00:00.000Z"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Queued user email job.

Media type application/json
object
success
required
boolean
email_job_id
required
string
user_id
required
string
template
required
string
status
required
string
created_at
required
string format: date-time
key
additional properties
Example 
{
  "success": true,
  "email_job_id": "email_job_123",
  "user_id": "user_123",
  "template": "security_alert",
  "status": "queued",
  "created_at": "2026-06-01T00:00:00.000Z"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}