createTemplate

Classic/VPC 환경에서 이용 가능합니다.

발송할 이메일의 제목과 본문 등을 설정하여 새로운 메일 템플릿을 생성합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/template

요청 헤더

Cloud Outbound Mailer API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Outbound Mailer 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`categorySid`	String	Optional	템플릿이 소속될 카테고리의 SID -1 (root) (기본값)
`templateName`	String	Required	생성할 템플릿의 이름 한글, 영문자, 숫자, 특수문자 '.', '_', '-'를 조합하여 1~100자 이내로 입력
`description`	String	Optional	템플릿에 대한 설명(Byte) 0~300
`title`	String	Required	이메일 제목(Byte) 1~500
`body`	String	Required	이메일 본문
`senderAddress`	String	Required	발송자 이메일 주소
`senderName`	String	Optional	발송자 이름(Byte) 0~69
`isUse`	Boolean	Optional	생성한 템플릿의 사용 여부 `true` \| `false` `true`: 템플릿 사용 `false`: 템플릿 사용하지 않음

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://mail.apigw.gov-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
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`sid`	Integer	-	생성한 템플릿의 SID
`createDate`	Object	-	생성 일시 NesDateTime 참조
`name`	String	-	생성한 템플릿의 이름
`description`	String	-	생성한 템플릿에 대한 설명
`title`	String	-	이메일 제목
`senderAddress`	String	-	발송자의 이메일 주소
`senderName`	String	-	발송자 이름
`body`	String	-	이메일 본문
`isUse`	Boolean	-	템플릿 사용 여부
`category`	Object	-	부모 카테고리의 정보 Category 참조

응답 상태 코드

Cloud Outbound Mailer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Outbound Mailer 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "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"
  }
}