updateTemplate

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

생성한 이메일 템플릿의 이름, 내용 등의 속성을 수정합니다.

요청

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

메서드	URI
PUT	/template/{templateSid}

요청 헤더

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

요청 경로 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`templateSid`	Integer	Required	수정할 템플릿의 SID getTemplateStructure를 통해 확인

요청 바디

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

필드	타입	필수 여부	설명
`templateName`	String	Required	수정할 템플릿의 이름 0~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 PUT 'https://mail.apigw.gov-ntruss.com/api/v1/template/258'
--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 '{
  "templateName": "membershipTemplateKR",
  "title": "[KO] Naver Cloud Platform",
  "body": "회원 가입을 환영합니다.",
  "senderAddress": "admin@master.com",
  "senderName": "Admin",
  "isUse": true
}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드	코드	설명
200	-	요청 성공
400	-	인증 실패, 잘못된 요청
400	77101	로그인 정보 오류
400	77102	요청 오류
400	77103	요청한 리소스가 존재하지 않음
403	77201	요청한 리소스에 대한 권한이 없음
403	77202	이메일 서비스 사용을 신청하지 않은 사용자가 호출한 경우
405	77001	지원되지 않는 메서드 유형
415	77002	지원되지 않는 미디어 유형
500	-	서버 오류
500	77301	기본 프로젝트가 존재하지 않음
500	77302	외부 시스템 API 연동 오류
500	77303	그 외 내부 서버 오류

응답 예시

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

{
  "sid": 258,
  "createDate": {
    "utc": 1589348863431,
    "formattedDate": "2020-05-13",
    "formattedDateTime": "2020-05-13 14:47:43 431"
  },
  "name": "membershipTemplateKR",
  "description": null,
  "title": "[KO] Naver Cloud Platform",
  "senderAddress": "admin@master.com",
  "senderName": "Admin",
  "body": "회원 가입을 환영합니다.",
  "isUse": true,
  "category": {
    "sid": 252,
    "parentSid": -1,
    "name": "testCategory"
  }
}