createTemplate
- 인쇄
- PDF
createTemplate
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
템플릿를 생성합니다.
POST https://mail.apigw.gov-ntruss.com/api/v1/template
요청
요청 파라미터
| 파라미터명 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| categorySid | No | String | Default:-1 (root) | 부모 카테고리 sid |
| templateName | Yes | String | Max:100 | 템플릿 이름 |
| description | No | String | Max:300 | 템플릿 설명 |
| title | Yes | String | Max:500 | 메일 제목 |
| body | Yes | String | 메일 본문 | |
| senderAddress | Yes | String | 발송자 메일 주소 | |
| senderName | No | String | Max:69 | 발송자 이름 |
| isUse | No | Boolean | Default:true | 템플릿 사용 여부 |
응답
| HTTP 상태코드 | 설명 |
|---|---|
| 201 | 템플릿 생성 완료 |
| 400 | 인증 실패, 잘못된 요청 |
| 500 | 서버 오류 |
예시
요청 예시
POST https://mail.apigw.gov-ntruss.com/api/v1/template
{
"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": 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"
}
}
속성
| 항목 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| sid | Yes | Integer | 생성한 템플릿의 sid | |
| createDate | Yes | NesDateTime | 생성 일시 | |
| name | Yes | String | 생성한 템플릿의 이름 | |
| description | No | String | 생성한 템플릿에 대한 설명 | |
| title | Yes | String | 메일 제목 | |
| senderAddress | Yes | String | 발송자 메일 주소 | |
| senderName | No | String | 발송자 이름 | |
| body | Yes | String | 메일 본문 | |
| isUse | Yes | Boolean | 템플릿 사용 여부 | |
| category | No | Category | 부모 카테고리 정보 |
오류 코드
| HTTP Status Code | 리턴 코드 | 응답 메시지 |
|---|---|---|
| 400 | 77101 | 로그인 정보 오류 |
| 400 | 77102 | BAD_REQUEST |
| 400 | 77103 | 리소스가 존재하지 않음 |
| 403 | 77201 | 권한 없음 |
| 403 | 77202 | Email 상품 사용신청 하지 않음 |
| 405 | 77001 | METHOD_NOT_ALLOWED |
| 415 | 77002 | UNSUPPORTED_MEDIA_TYPE |
| 500 | 77301 | 기본 프로젝트가 존재하지 않음 |
| 500 | 77302 | 외부 시스템 API 연동 오류 |
| 500 | 77303 | 그외 INTERNAL_SERVER_ERROR |
이 문서가 도움이 되었습니까?