The email 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.
Create an email
Create and send an email to the supplied email address ID.
SecuritybearerAuth
Request
Request Body schema: application/json
Required parameters
| from_email_name | string The email name portion of the sending email address.
|
| subject | string or null The subject of the email. |
| body | string or null The body of the email. |
| email_address_id | string or null The ID of the email address to send to. |
| template_slug | string or null The slug of the template to use for sending this email |
Responses
200
Success
400
Request was not successful
401
Authentication invalid
403
Authorization invalid
404
Resource not found
422
Invalid request parameters
post/emails
Request samples
- Payload
application/json
{- "from_email_name": "string",
- "subject": "string",
- "body": "string",
- "email_address_id": "string",
- "template_slug": "string"
}Response samples
- 200
- 400
- 401
- 403
- 404
- 422
application/json
{- "object": "email",
- "id": "string",
- "slug": "string",
- "from_email_name": "string",
- "email_address_id": "string",
- "to_email_address": "string",
- "user_id": "string",
- "subject": "string",
- "body": "string",
- "body_plain": "string",
- "status": "string",
- "data": { },
- "delivered_by_clerk": true
}