• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLink
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • search
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / Reference / REST API

email-templates

Postman Collection
OpenAPI
Operations
GET/api/2/email-templatesPOST/api/2/email-templatesPOST/api/2/email-templates/applyPOST/api/2/email-templates/revertGET/api/2/email-templates/types
GET

Get email templates as zip file

Creates a zip file containing email templates at local home and returns the file.

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Zipping was successful

GET/api/2/email-templates
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/email-templates' \ --user 'email@example.com:<api_token>'
POST

Update email templates with zip file

Extracts given zip file to temporary templates folder. If the folder already exists it will replace it's content

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/zip

object

Responses

Templates has extracted

POST/api/2/email-templates
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/api/2/email-templates' \ --user 'email@example.com:<api_token>'
POST

Update email templates with previously uploaded pack

Replaces the current email templates pack with previously uploaded one, if exists.

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Templates were replaced

POST/api/2/email-templates/apply
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/api/2/email-templates/apply' \ --user 'email@example.com:<api_token>'
POST

Update email templates to default

Replaces the current email templates pack with default templates, which are copied over from Jira binaries.

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Templates were restored to default

POST/api/2/email-templates/revert
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/api/2/email-templates/revert' \ --user 'email@example.com:<api_token>'
GET

Get email types for templates

Returns a list of root templates mapped with Event Types. The list can be used to decide which test emails to send.

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Reading email types was successful

GET/api/2/email-templates/types
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/email-templates/types' \ --user 'email@example.com:<api_token>'

Rate this page: