getTemplateStructure

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:

Method	URI
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.

Field	Type	Required	Description
`isUse`	Boolean	Optional	Whether 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}'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`contents`	TemplateStructureResponse	Optional	Detailed structure of templates and categories to get

Response status codes

The following describes the response status codes.

HTTP status code	Code	Description
200	-	Request succeeded
400	-	Authentication failed, invalid request
400	77101	Error in login information
400	77102	Request error
400	77103	Requested resource does not exist
403	77201	No permissions to the requested resource
403	77202	Call from a user who hasn't subscribed to the email service
405	77001	Unsupported method type
415	77002	Unsupported media type
500	-	Server error
500	77301	Default project does not exist
500	77302	External system API integration error
500	77303	Other 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
        }
      ]
    }
  ]
}