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 Message API

The Message API from FusionAuth — 3 operation(s) for message.

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

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

This API exposes 8 operations across 3 paths, and defines 11 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.

8 operations 3 paths 11 schemas 1 DELETE2 GET1 PATCH3 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 Message 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 8

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

Message 8
POST
/api/message/template
Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
createMessageTemplate body → 200default
GET
/api/message/template
Retrieves the message template for the given Id. If you don't specify the Id, this will return all the message templates.
retrieveMessageTemplate → 200default
POST
/api/message/template/preview
Creates a preview of the message template provided in the request, normalized to a given locale.
retrieveMessageTemplatePreviewWithId body → 200default
POST
/api/message/template/{messageTemplateId}
Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
createMessageTemplateWithId 1 param body → 200default
DELETE
/api/message/template/{messageTemplateId}
Deletes the message template for the given Id.
deleteMessageTemplateWithId 1 param → 200default
PATCH
/api/message/template/{messageTemplateId}
Updates, via PATCH, the message template with the given Id.
patchMessageTemplateWithId 1 param body → 200default
GET
/api/message/template/{messageTemplateId}
Retrieves the message template for the given Id. If you don't specify the Id, this will return all the message templates.
retrieveMessageTemplateWithId 1 param → 200default
PUT
/api/message/template/{messageTemplateId}
Updates the message template with the given Id.
updateMessageTemplateWithId 1 param body → 200default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are MessageTemplate (6 properties), Error (3 properties), PreviewMessageTemplateResponse (3 properties), MessageTemplateResponse (2 properties). Each schema is shown below with its type and property counts.

MessageTemplateResponse
object
2 properties
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
MessageTemplateRequest
object
A Message Template Request to the API
1 property
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.
PreviewMessageTemplateRequest
object
2 properties
PreviewMessageTemplateResponse
object
3 properties
Error
object
Defines an error.
3 properties
MessageType
string
MessageTemplate
object
Stores an message template used to distribute messages;
6 properties
SMSMessage
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusionauth-message-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 Email API
FusionAuth Entity API
FusionAuth Form API
FusionAuth Group API
FusionAuth Health API
FusionAuth Identity API
FusionAuth Identity Provider API
FusionAuth Integration API
Where this information came from

This is an independent, third-party profile of FusionAuth Message 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.