createCategory
    • PDF

    createCategory

    • PDF

    Article summary

    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:

    MethodURI
    POST/category

    Request headers

    For headers common to Cloud Outbound Mailer APIs, see Cloud Outbound Mailer request headers.

    Request body

    The following describes the request body.

    FieldTypeRequiredDescription
    categoryNameStringRequiredName of the category to create
    • 1 to 100 characters, containing Korean letters, English letters, numbers, periods (.), underscores (_), and hyphens (-)
    parentSidIntegerOptionalSID 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.

    FieldTypeRequiredDescription
    sidIntegerRequiredSID of the created category
    parentSidIntegerRequiredSID of the parent category
    nameStringRequiredName of the created category

    Response status codes

    The following describes the response status codes.

    HTTP status codeCodeDescription
    201-Request succeeded
    400-Authentication failed, invalid request
    40077101Error in login information
    40077102Request error
    40077103Requested resource does not exist
    40377201No permissions to the requested resource
    40377202Call from a user who hasn't subscribed to the email service
    40577001Unsupported method type
    41577002Unsupported media type
    500-Server error
    50077301Default project does not exist
    50077302External system API integration error
    50077303Other internal server error

    Response example

    The following is a sample response.

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

    Was this article helpful?

    What's Next
    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.