MENU
      getTemplateStructure

        getTemplateStructure


        Article summary

        Available in Classic and VPC

        Get email templates and category structure.

        Request

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

        MethodURI
        GET/template

        Request headers

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

        Request query parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        isUseBooleanOptionalWhether to view only templates and category structures in use
        • true | false
          • true: View only templates and categories in use
          • false: View templates and categories not in use as well

        Request example

        The following is a sample request.

        curl --location --request GET 'https://mail.apigw.ntruss.com/api/v1/template
        ?isUse=true'
        --header 'x-ncp-apigw-timestamp: {Timestamp}'
        --header 'x-ncp-iam-access-key: {Access Key}'
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
        Curl

        Response

        The following describes the response format.

        Response body

        The following describes the response body.

        FieldTypeRequiredDescription
        contentsTemplateStructureResponseOptionalDetailed structure of templates and categories to get

        Response status codes

        The following describes the response status codes.

        HTTP status codeCodeDescription
        200-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.

        {
          "contents": [
            {
              "sid": 261,
              "parentSid": -1,
              "createDate": {
                "utc": 1589355820663,
                "formattedDate": "2020-05-13",
                "formattedDateTime": "2020-05-13 16:43:40 663"
              },
              "name": "AD",
              "isCategory": true,
              "isUse": true,
              "subCategories": null,
              "templates": [
                {
                  "sid": 262,
                  "parentSid": 261,
                  "createDate": {
                    "utc": 1589355868201,
                    "formattedDate": "2020-05-13",
                    "formattedDateTime": "2020-05-13 16:44:28 201"
                  },
                  "name": "AD_Template",
                  "isCategory": false,
                  "isUse": true,
                  "subCategories": null,
                  "templates": null
                }
              ]
            }
          ]
        }
        JSON

        Was this article helpful?

        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.