MENU
      createTemplate

        createTemplate


        기사 요약

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

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

        요청

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

        메서드URI
        POST/template

        요청 헤더

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

        요청 바디

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

        필드타입필수 여부설명
        categorySidStringOptional템플릿이 소속될 카테고리의 SID
        • -1 (root) (기본값)
        templateNameStringRequired생성할 템플릿의 이름
        • 0~100자로 한글, 영문자, 숫자, 마침표(.), 언더바(_), 하이픈(-) 허용
        descriptionStringOptional템플릿에 대한 설명(Byte)
        • 0~300
        titleStringRequired이메일 제목(Byte)
        • 1~500
        bodyStringRequired이메일 본문
        senderAddressStringRequired발송자 이메일 주소
        senderNameStringOptional발송자 이름(Byte)
        • 0~69
        isUseBooleanOptional생성한 템플릿의 사용 여부
        • true | false
          • true: 템플릿 사용
          • false: 템플릿 사용하지 않음

        요청 예시

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

        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
        }'
        Curl

        응답

        응답 형식을 설명합니다.

        응답 바디

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

        필드타입필수 여부설명
        sidIntegerRequired생성한 템플릿의 SID
        createDateNesDateTimeRequired생성 일시
        nameStringRequired생성한 템플릿의 이름
        descriptionStringOptional생성한 템플릿에 대한 설명
        titleStringRequired이메일 제목
        senderAddressStringRequired발송자의 이메일 주소
        senderNameStringOptional발송자 이름
        bodyStringRequired이메일 본문
        isUseBooleanRequired템플릿 사용 여부
        categoryCategoryOptional부모 카테고리의 정보

        응답 상태 코드

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

        HTTP 상태 코드코드설명
        201-요청 성공
        400-인증 실패, 잘못된 요청
        40077101로그인 정보 오류
        40077102요청 오류
        40077103요청한 리소스가 존재하지 않음
        40377201요청한 리소스에 대한 권한이 없음
        40377202이메일 서비스 사용을 신청하지 않은 사용자가 호출한 경우
        40577001지원되지 않는 메서드 유형
        41577002지원되지 않는 미디어 유형
        500-서버 오류
        50077301기본 프로젝트가 존재하지 않음
        50077302외부 시스템 API 연동 오류
        50077303그 외 내부 서버 오류

        응답 예시

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

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

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.