getTemplateStructure
    • PDF

    getTemplateStructure

    • PDF

    Article Summary

    Querying templates and category structures

    GET https://{endpoint}/template
    

    Requests

    Request parameters

    Parameter nameRequirement statusTypeRestrictionsDescription
    isUseNoBooleanDefault: Full queryWhether to query only those in use

    Responses

    HTTP status codeDescription
    200Successful template and category structure query
    400Authentication failed; bad request
    500Server error

    Examples

    Request examples

    GET https://mail.apigw.ntruss.com/api/v1/template?isUse=true
    

    Response examples

    {
      "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
            }
          ]
        }
      ]
    }
    

    Properties

    ItemRequirement statusTypeRestrictionsDescription
    contentsNoList<TemplateStructureResponse>Template and category structure details

    Errors

    HTTP Status CodeReturn codeResponse message
    40077101Login information error
    40077102BAD_REQUEST
    40077103Resource does not exist
    40377201No permission
    40377202No prior request to subscribe to email service
    40577001METHOD_NOT_ALLOWED
    41577002UNSUPPORTED_MEDIA_TYPE
    50077301Default project does not exist
    50077302External system API linkage error
    50077303Other INTERNAL_SERVER_ERROR

    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.