How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

FusionAuth Email API

The Email API from FusionAuth — 5 operation(s) for email.

FusionAuth Email API is one of 37 APIs that FusionAuth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Email. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.66.0.

Requests are made against 2 base URLs: http://localhost:9011, https://sandbox.fusionauth.io.

10 operations 5 paths 19 schemas 1 DELETE2 GET1 PATCH5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.66.0
Base URL
https://sandbox.fusionauth.io
Authentication
API Key, HTTP Bearer
License
Apache2
Resource Areas
1

Authentication & Security 2

FusionAuth Email API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 1 PATCH, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Email 10
POST
/api/email/send/{emailTemplateId}
Send an email using an email template Id. You can optionally provide requestData to access key value pairs in the email template.
sendEmailWithId 1 param body → 200default
POST
/api/email/template
Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
createEmailTemplate 1 param body → 200default
GET
/api/email/template
Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
retrieveEmailTemplate 1 param → 200default
POST
/api/email/template/preview
Creates a preview of the email template provided in the request. This allows you to preview an email template that hasn't been saved to the database yet. The entire email template does not need to be…
retrieveEmailTemplatePreviewWithId body → 200default
POST
/api/email/template/search
Searches email templates with the specified criteria and pagination.
searchEmailTemplatesWithId body → 200default
POST
/api/email/template/{emailTemplateId}
Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
createEmailTemplateWithId 2 params body → 200default
DELETE
/api/email/template/{emailTemplateId}
Deletes the email template for the given Id.
deleteEmailTemplateWithId 2 params → 200default
PATCH
/api/email/template/{emailTemplateId}
Updates, via PATCH, the email template with the given Id.
patchEmailTemplateWithId 2 params body → 200default
GET
/api/email/template/{emailTemplateId}
Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
retrieveEmailTemplateWithId 2 params → 200default
PUT
/api/email/template/{emailTemplateId}
Updates the email template with the given Id.
updateEmailTemplateWithId 2 params body → 200default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are EmailTemplate (13 properties), Email (9 properties), SendRequest (7 properties), EmailTemplateSearchCriteria (4 properties). Each schema is shown below with its type and property counts.

Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
EmailTemplateRequest
object
Email template request.
1 property
EmailTemplateErrors
object
2 properties
SendRequest
object
7 properties
PreviewRequest
object
2 properties
Locale
string
A Locale object represents a specific geographical, political, or cultural region.
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
SendResponse
object
2 properties
EmailTemplateSearchResponse
object
Email template search response
2 properties
EmailTemplateSearchRequest
object
Search request for email templates
1 property
EmailTemplate
object
Stores an email template used to send emails to users.
13 properties
EmailAddress
object
An email address.
2 properties
Attachment
object
This class is a simple attachment with a byte array, name and MIME type.
3 properties
LocalizedStrings
object
Models a set of localized Strings that can be stored as JSON.
EmailTemplateSearchCriteria
object
Search criteria for Email templates
4 properties
Email
object
This class is an abstraction of a simple email message.
9 properties
PreviewResponse
object
2 properties
EmailTemplateResponse
object
Email template response.
2 properties
Error
object
Defines an error.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusionauth-email-api-openapi.yml Raw ↑

Other APIs FusionAuth publishes across the network.

FusionAuth Api Key API
FusionAuth Application API
FusionAuth Connector API
FusionAuth Consent API
FusionAuth Entity API
FusionAuth Form API
FusionAuth Group API
FusionAuth Health API
FusionAuth Identity API
FusionAuth Identity Provider API
FusionAuth Integration API
FusionAuth Ip Acl API
Where this information came from

This is an independent, third-party profile of FusionAuth Email API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.