{
  "opencollection": "1.0.0",
  "info": {
    "name": "Kong Enterprise Admin ACLs Portal Emails API",
    "version": "3.14.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Kong-Admin-Token",
      "value": "{{Kong-Admin-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Portal Emails",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the email config for the portal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-config",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              }
            ]
          },
          "docs": "Retrieve the email config for the portal"
        },
        {
          "info": {
            "name": "Create the email config for a portal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-config",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create the email config for a portal"
        },
        {
          "info": {
            "name": "Setup the email config for a portal",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-config",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Setup the email config for a portal"
        },
        {
          "info": {
            "name": "Delete portal email config",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-config",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              }
            ]
          },
          "docs": "Delete portal email config"
        },
        {
          "info": {
            "name": "Get the email delivery for the portal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-delivery",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              }
            ]
          },
          "docs": "Retrieve the email delivery for the portal"
        },
        {
          "info": {
            "name": "Setup the email delivery for a portal",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-delivery",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Setup the email delivery for a portal"
        },
        {
          "info": {
            "name": "Delete email delivery",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-delivery",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              }
            ]
          },
          "docs": "Delete email delivery"
        },
        {
          "info": {
            "name": "List custom email templates for a portal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-templates",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              }
            ]
          },
          "docs": "List custom email templates"
        },
        {
          "info": {
            "name": "Get custom email template used in a portal",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-templates/:templateName",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              },
              {
                "name": "templateName",
                "value": "",
                "type": "path",
                "description": "Name of the email template."
              }
            ]
          },
          "docs": "Get custom email template"
        },
        {
          "info": {
            "name": "Update custom email template for a portal",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-templates/:templateName",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              },
              {
                "name": "templateName",
                "value": "",
                "type": "path",
                "description": "Name of the email template."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update custom email template"
        },
        {
          "info": {
            "name": "Delete custom email template",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-templates/:templateName",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              },
              {
                "name": "templateName",
                "value": "",
                "type": "path",
                "description": "Name of the email template."
              }
            ]
          },
          "docs": "Delete custom email template for a portal. This will revert to using the default template"
        },
        {
          "info": {
            "name": "Send Test Email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/:portalId/email-templates/:templateName/send-test-email",
            "params": [
              {
                "name": "portalId",
                "value": "",
                "type": "path",
                "description": "ID of the portal."
              },
              {
                "name": "templateName",
                "value": "",
                "type": "path",
                "description": "Name of the email template."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send a test email based on the portal's email template, using the content provided in the request.\nThe email will be sent to the Konnect user who triggered the test."
        },
        {
          "info": {
            "name": "List email domains",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/email-domains",
            "params": [
              {
                "name": "page[size]",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to include per page. The last page of a collection may include fewer items."
              },
              {
                "name": "page[number]",
                "value": "",
                "type": "query",
                "description": "Determines which page of the entities to retrieve."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sorts a collection of email domains. Supported sort attributes are:\n  - domain\n  - created_at\n  - updated_at\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Filter email domains returned in the response."
              }
            ]
          },
          "docs": "List email domains"
        },
        {
          "info": {
            "name": "Create an email domain",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/email-domains",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an email domain"
        },
        {
          "info": {
            "name": "Get an email domain",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/email-domains/:emailDomain",
            "params": [
              {
                "name": "emailDomain",
                "value": "",
                "type": "path",
                "description": "Email domain for custom portal email sender"
              }
            ]
          },
          "docs": "Get an email domain"
        },
        {
          "info": {
            "name": "Delete an email domain",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/email-domains/:emailDomain",
            "params": [
              {
                "name": "emailDomain",
                "value": "",
                "type": "path",
                "description": "Email domain for custom portal email sender"
              }
            ]
          },
          "docs": "Delete an email domain"
        },
        {
          "info": {
            "name": "List default email templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/email-templates"
          },
          "docs": "List default email templates"
        },
        {
          "info": {
            "name": "Get default email template",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/email-templates/:templateName",
            "params": [
              {
                "name": "templateName",
                "value": "",
                "type": "path",
                "description": "Name of the email template."
              }
            ]
          },
          "docs": "Get default email template"
        },
        {
          "info": {
            "name": "List email template variables",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}{path}/v3/portals/email-templates/variables"
          },
          "docs": "List email template variables"
        }
      ]
    }
  ],
  "bundled": true
}