createCategory

Prev Next

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

이메일 템플릿을 분류할 수 있는 카테고리를 생성합니다.

요청

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

메서드 URI
POST /category

요청 헤더

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

요청 바디

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

필드 타입 필수 여부 설명
categoryName String Required 생성할 카테고리의 이름
  • 한글, 영문자, 숫자, 특수문자 '.', '_', '-'를 조합하여 1~100자 이내로 입력
parentSid Integer Optional 부모 카테고리의 SID
  • -1 (root) (기본값)
  • 특정 카테고리 하위에 새 카테고리를 생성할 경우 입력

요청 예시

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

curl --location --request POST 'https://mail.apigw.gov-ntruss.com/api/v1/category' \
--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 '{
  "categoryName": "testCategory",
  "parentSid": -1
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
sid Integer - 생성한 카테고리의 SID
parentSid Integer - 부모 카테고리의 SID
name String - 생성한 카테고리의 이름

응답 상태 코드

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

응답 예시

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

{
  "sid": 252,
  "parentSid": -1,
  "name": "testCategory"
}