Skip to content

Create an account-level template

Request

Store a new account-level template that is available across all domains for the account. Include the template 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
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.

curl -i -X POST \
  -u '<username>:<password>' \
  https://api.mailgun.net/v4/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": {} } }