createTemplate

Available in Classic and VPC

Create a new mail template by setting the subject, body, etc. of the email you want to send.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
POST	/template

Request headers

For information about the headers common to all Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.

Request body

The following describes the request body.

Field	Type	Required	Description
`categorySid`	String	Optional	SID of the category the template will belong to -1 (root) (default)
`templateName`	String	Required	Name of the template to create 1 to 100 characters, containing Korean letters, English letters, numbers, periods (.), underscores (_), and hyphens (-)
`description`	String	Optional	Description of the template (byte) 0 - 300
`title`	String	Required	Email subject (byte) 1 - 500
`body`	String	Required	Email body
`senderAddress`	String	Required	Sender's email address
`senderName`	String	Optional	Sender's name (byte) 0 - 69
`isUse`	Boolean	Optional	Whether to use the template created `true` \| `false` `true`: use template `false`: not use template

Request example

The following is a sample request.

curl --location --request POST 'https://mail.apigw.ntruss.com/api/v1/template' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "categorySid": 252,
  "templateName": "membershipTemplate",
  "description": "Example of creating a template",
  "title": "[EN] Naver Cloud Platform",
  "body": "Congratulations on your membership.",
  "senderAddress": "admin@master.com",
  "senderName": "Admin",
  "isUse": true
}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`sid`	Integer	-	SID of the created template
`createDate`	Object	-	Creation date and time See NesDateTime
`name`	String	-	Name of the created template
`description`	String	-	Description of the created template
`title`	String	-	Email subject
`senderAddress`	String	-	Sender's email address
`senderName`	String	-	Sender name
`body`	String	-	Email body
`isUse`	Boolean	-	Template usage status
`category`	Object	-	Parent category information See Category

Response status codes

For information about the HTTP status codes common to all Cloud Outbound Mailer APIs, see Cloud Outbound Mailer response status codes.

Response example

The following is a sample response.

{
  "sid": 258,
  "createDate": {
    "utc": 1589348863431,
    "formattedDate": "2020-05-13",
    "formattedDateTime": "2020-05-13 14:47:43 431"
  },
  "name": "membershipTemplate",
  "description": "Example of creating a template",
  "title": "[EN] Naver Cloud Platform",
  "senderAddress": "admin@master.com",
  "senderName": "Admin",
  "body": "Congratulations on your membership.",
  "isUse": true,
  "category": {
    "sid": 252,
    "parentSid": -1,
    "name": "testCategory"
  }
}