TemplateControllerApi

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
createTemplatePOST /templatesCreate a Template
deleteTemplateDELETE /templates/{TemplateId}Delete Template
getAllTemplatesGET /templates/paginatedGet all Templates in paginated format
getTemplateGET /templates/{TemplateId}Get Template
getTemplatesGET /templatesGet all Templates

createTemplate

TemplateDto createTemplate(createTemplateOptions)

Create a Template

Parameters

NameTypeDescriptionNotes
createTemplateOptionsCreateTemplateOptionscreateTemplateOptions

Return type

TemplateDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteTemplate

deleteTemplate(TemplateId)

Delete Template

Parameters

NameTypeDescriptionNotes
TemplateIdUUIDTemplateId[default to null]

Return type

null (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getAllTemplates

PageTemplateProjection getAllTemplates(page, size, sort)

Get all Templates in paginated format

Parameters

NameTypeDescriptionNotes
pageIntegerOptional page in inbox list pagination[optional] [default to 0]
sizeIntegerOptional page size in inbox list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageTemplateProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getTemplate

TemplateDto getTemplate(TemplateId)

Get Template

Parameters

NameTypeDescriptionNotes
TemplateIdUUIDTemplateId[default to null]

Return type

TemplateDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getTemplates

List getTemplates()

Get all Templates

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json