updateTemplateLocationOrName

Prev Next

Available in Classic and VPC

Edit the location and name of a user-created mail template.

Request

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

Method URI
PUT /template/{templateSid}/name-location

Request headers

For headers common to Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.

Request path parameters

The following describes the parameters.

Field Type Required Description
templateSid Integer Required SID of the template to edit

Request body

The following describes the request body.

Field Type Required Description
templateName String Required Name of the template to edit
  • 0 - 100 characters
parentSid Integer Optional SID of the parent category
lowerSid Integer Optional SID of the template or category you want to place under
  • Use for repositioning purposes
  • Ignore if not applicable

Request example

The following is a sample request.

curl --location --request PUT 'https://mail.apigw.ntruss.com/api/v1/template/259/name-location' 
--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 '{
  "templateName": "AD Template",
  "parentSid": 252,
  "lowerSid": 255
}'

Response

The following describes the response format.

Response body

The following describes the response body.

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

Response status codes

The following describes the response status codes.

HTTP status code Code Description
200 - Request succeeded
400 - Authentication failed, invalid request
400 77101 Error in login information
400 77102 Request error
400 77103 Requested resource does not exist
403 77201 No permissions to the requested resource
403 77202 Call from a user who hasn't subscribed to the email service
405 77001 Unsupported method type
415 77002 Unsupported media type
500 - Server error
500 77301 Default project does not exist
500 77302 External system API integration error
500 77303 Other internal server error

Response example

The following is a sample response.

{
  "sid": 259,
  "createDate": {
    "utc": 1589349277158,
    "formattedDate": "2020-05-13",
    "formattedDateTime": "2020-05-13 14:54:37 158"
  },
  "name": "AD Template",
  "description": null,
  "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"
  }
}