Emails

This object represents an email that has been sent to an email address. You can only send an email to email addresses that have been verified by a user. Only recommended for transactional emails.

Available requests

  • POST/v1/emails

Example email schema

{
"id": "ema_1q93E6N25LCxLpHeR0NekHCsBiY",
"object": "email",
"from_email_name": "support",
"to_email_address": "[email protected]",
"email_address_id": "idn_1n5AVtYAHNQY73d6dY6GVJt8gmD",
"subject": "green test",
"body": "this is a green test",
"status": "queued"
}

post
Create an email

https://api.clerk.dev/v1/emails
Create and send an email to the supplied email address ID.
Request
Response
Request
Headers
Authorization
required
string
Bearer [YOUR_API_KEY]
Form Data Parameters
email_address_id
required
string
The ID of a verified email address
from_email_name
required
string
The name portion of the from email address. e.g. "support" will send the email from [email protected][YOUR_DOMAIN].com
subject
required
string
The subject of the email being sent.
body
required
string
The body of the email being sent.
Response
200: OK
// see example schema
{
"object": "email",
"id": "ema_1q93E6N25LCxLpHeR0NekHCsBiY",
...
}