Create a template

Request

Store a new template, including its name, description and (optionally) the template content. If the template content is provided, a new version is automatically created and becomes the active version.

Security

basicAuth

Path

domain_namestringrequired

Domain name the template is associated with.

Bodymultipart/form-datarequired

namestringrequired

Name of the template being stored. Supports utf-8 characters and name will be down cased.

descriptionstring

Description of the template being stored

createdBystring

Optional metadata field api user can indicate who created the template.

templatestring

Content of the template.

tagstring

Initial tag of the created version. If the template parameter is provided and the tag is missing, the default value initial is used.

commentstring

Version comment. This is valid only if a new version is being created. (template parameter is provided.)

headersstring

Key value JSON object of headers to be stored with the template. Where key is the header name and value is the header value. The header names From, Subject, and Reply-To are the only ones currently supported. These headers will be inserted into the MIME at the time we attempt delivery.

Headers set at the message level will override headers set on the template. e.g. Setting the From header at the time of sending will override the From header saved on the template. Additionally, headers generated by templates are not reflected on the accepted event as they are not prepended to the message until the message is prepped for delivery. if a From header is not provided either in the message or template, we will default to postmaster@your-sending-domain.tld

curl -i -X POST \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v3/{domain_name}/templates' \
  -H 'Content-Type: multipart/form-data' \
  -F name=string \
  -F description=string \
  -F createdBy=string \
  -F template=string \
  -F tag=string \
  -F comment=string \
  -F headers=string

Responses

A 200 response

Bodyapplication/json

messagestringrequired

Response message

templategithub.com-mailgun-temple-model-Template (object) or nullrequired

Any of:

Template details

Response

{
  "message": "template has been stored",
  "template": {
    "name": "template_name",
    "description": "This is the description of the template",
    "createdAt": "Sat, 12 Nov 1955 06:38:00 UTC",
    "createdBy": "user-supplied-value",
    "id": "46565d87-68b6-4edb-8b3c-34554af4bb77",
    "domain": "header.tld",
    "version": { … }
  }
}