FusionAuth API — Email Template

naftiko: 1.0.0-alpha2
info:
  label: FusionAuth API — Email Template
  description: 'FusionAuth API — Email Template. 10 operations. Lead operation: Retrieves the email template for the given Id. If you don''t specify the Id, this will return all the email templates.. Self-contained Naftiko capability covering one business surface.'
  tags:
  - FusionAuth
  - Email Template
  created: '2026-05-20'
  modified: '2026-05-20'
binds:
- namespace: env
  keys:
    FUSIONAUTH_API_KEY: FUSIONAUTH_API_KEY
capability:
  consumes:
  - type: http
    namespace: fusionauth-email-template
    baseUri: http://localhost:9011
    description: FusionAuth API — Email Template business capability. Self-contained, no shared references.
    resources:
    - name: api-email-send-emailtemplateid
      path: /api/email/send/{emailTemplateId}
      operations:
      - name: sendemailwithid
        method: POST
        description: Send an email using an email template Id. You can optionally provide requestData to access key value pairs in the email template.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: emailTemplateId
          in: path
          type: string
          description: The Id for the template.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-email-template
      path: /api/email/template
      operations:
      - name: createemailtemplate
        method: POST
        description: Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: retrieveemailtemplate
        method: GET
        description: Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
    - name: api-email-template-preview
      path: /api/email/template/preview
      operations:
      - name: retrieveemailtemplatepreviewwithid
        method: POST
        description: '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 '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-email-template-search
      path: /api/email/template/search
      operations:
      - name: searchemailtemplateswithid
        method: POST
        description: Searches email templates with the specified criteria and pagination.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-email-template-emailtemplateid
      path: /api/email/template/{emailTemplateId}
      operations:
      - name: createemailtemplatewithid
        method: POST
        description: Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: emailTemplateId
          in: path
          type: string
          description: The Id for the template. If not provided a secure random UUID will be generated.
          required: true
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteemailtemplatewithid
        method: DELETE
        description: Deletes the email template for the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: emailTemplateId
          in: path
          type: string
          description: The Id of the email template to delete.
          required: true
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
      - name: patchemailtemplatewithid
        method: PATCH
        description: Updates, via PATCH, the email template with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: emailTemplateId
          in: path
          type: string
          description: The Id of the email template to update.
          required: true
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: retrieveemailtemplatewithid
        method: GET
        description: Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: emailTemplateId
          in: path
          type: string
          description: The Id of the email template.
          required: true
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
      - name: updateemailtemplatewithid
        method: PUT
        description: Updates the email template with the given Id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: emailTemplateId
          in: path
          type: string
          description: The Id of the email template to update.
          required: true
        - name: X-FusionAuth-TenantId
          in: header
          type: string
          description: The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: fusionauth-email-template-rest
    port: 8080
    description: REST adapter for FusionAuth API — Email Template. One resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/email/send/{emailTemplateId}
      name: api-email-send-emailtemplateid
      description: REST surface for api-email-send-emailtemplateid.
      operations:
      - method: POST
        name: sendemailwithid
        description: Send an email using an email template Id. You can optionally provide requestData to access key value pairs in the email template.
        call: fusionauth-email-template.sendemailwithid
        with:
          emailTemplateId: rest.emailTemplateId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/email/template
      name: api-email-template
      description: REST surface for api-email-template.
      operations:
      - method: POST
        name: createemailtemplate
        description: Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
        call: fusionauth-email-template.createemailtemplate
        with:
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrieveemailtemplate
        description: Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
        call: fusionauth-email-template.retrieveemailtemplate
        with:
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/email/template/preview
      name: api-email-template-preview
      description: REST surface for api-email-template-preview.
      operations:
      - method: POST
        name: retrieveemailtemplatepreviewwithid
        description: '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 '
        call: fusionauth-email-template.retrieveemailtemplatepreviewwithid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/email/template/search
      name: api-email-template-search
      description: REST surface for api-email-template-search.
      operations:
      - method: POST
        name: searchemailtemplateswithid
        description: Searches email templates with the specified criteria and pagination.
        call: fusionauth-email-template.searchemailtemplateswithid
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/email/template/{emailTemplateId}
      name: api-email-template-emailtemplateid
      description: REST surface for api-email-template-emailtemplateid.
      operations:
      - method: POST
        name: createemailtemplatewithid
        description: Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
        call: fusionauth-email-template.createemailtemplatewithid
        with:
          emailTemplateId: rest.emailTemplateId
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteemailtemplatewithid
        description: Deletes the email template for the given Id.
        call: fusionauth-email-template.deleteemailtemplatewithid
        with:
          emailTemplateId: rest.emailTemplateId
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchemailtemplatewithid
        description: Updates, via PATCH, the email template with the given Id.
        call: fusionauth-email-template.patchemailtemplatewithid
        with:
          emailTemplateId: rest.emailTemplateId
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: retrieveemailtemplatewithid
        description: Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
        call: fusionauth-email-template.retrieveemailtemplatewithid
        with:
          emailTemplateId: rest.emailTemplateId
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateemailtemplatewithid
        description: Updates the email template with the given Id.
        call: fusionauth-email-template.updateemailtemplatewithid
        with:
          emailTemplateId: rest.emailTemplateId
          X-FusionAuth-TenantId: rest.X-FusionAuth-TenantId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: fusionauth-email-template-mcp
    port: 9090
    transport: http
    description: MCP adapter for FusionAuth API — Email Template. One tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: fusionauth-sendemailwithid
      description: Send an email using an email template Id. You can optionally provide requestData to access key value pairs in the email template.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-email-template.sendemailwithid
      with:
        emailTemplateId: tools.emailTemplateId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-createemailtemplate
      description: Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-email-template.createemailtemplate
      with:
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrieveemailtemplate
      description: Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-email-template.retrieveemailtemplate
      with:
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrieveemailtemplatepreviewwithid
      description: '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 '
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-email-template.retrieveemailtemplatepreviewwithid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-searchemailtemplateswithid
      description: Searches email templates with the specified criteria and pagination.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-email-template.searchemailtemplateswithid
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-createemailtemplatewithid
      description: Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-email-template.createemailtemplatewithid
      with:
        emailTemplateId: tools.emailTemplateId
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-deleteemailtemplatewithid
      description: Deletes the email template for the given Id.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: fusionauth-email-template.deleteemailtemplatewithid
      with:
        emailTemplateId: tools.emailTemplateId
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-patchemailtemplatewithid
      description: Updates, via PATCH, the email template with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: fusionauth-email-template.patchemailtemplatewithid
      with:
        emailTemplateId: tools.emailTemplateId
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-retrieveemailtemplatewithid
      description: Retrieves the email template for the given Id. If you don't specify the Id, this will return all the email templates.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: fusionauth-email-template.retrieveemailtemplatewithid
      with:
        emailTemplateId: tools.emailTemplateId
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
      outputParameters:
      - type: object
        mapping: $.
    - name: fusionauth-updateemailtemplatewithid
      description: Updates the email template with the given Id.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: fusionauth-email-template.updateemailtemplatewithid
      with:
        emailTemplateId: tools.emailTemplateId
        X-FusionAuth-TenantId: tools.X-FusionAuth-TenantId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.