createCategory

Available in Classic and VPC

Create a category to categorize email templates.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
POST	/category

Request headers

For information about the headers common to all Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.

Request body

The following describes the request body.

Field	Type	Required	Description
`categoryName`	String	Required	Name of the category to create 1 to 100 characters, containing Korean letters, English letters, numbers, periods (.), underscores (_), and hyphens (-)
`parentSid`	Integer	Optional	SID of the parent category - 1 (root) (default) Enter if you are creating a new category under a specific category

Request example

The following is a sample request.

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

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`sid`	Integer	-	SID of the created category
`parentSid`	Integer	-	SID of the parent category
`name`	String	-	Name of the created category

Response status codes

For information about the HTTP status codes common to all Cloud Outbound Mailer APIs, see Cloud Outbound Mailer response status codes.

Response example

The following is a sample response.

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