v1

latestSwagger 2.02026-08-041113661.2 MB

List emails

get/v1beta/emails

Query parameters

idinteger

Object ID.

namestring

Template name.

groupstring

Email template type. There are several types of ICANN emails that can be customized in Openprovider: -errp (Expired Registration Recovery policy emails) -foa (Form of Authorization emails for domain transfers approval rejection) -ive (Information verification emails, such emails used to verify email address of the customer) -tcn (Trademark Claims Notification emails) -wdrp (Whois Data Reminder Policy emails).

limitinteger

Output limit.

offsetinteger

Output offset.

is_systemboolean

Is system.

Response

A successful response.

codeinteger

descstring

maintenanceboolean

Example response

{
  "code": 0,
  "data": {
    "results": [
      {
        "fields": [
          {
            "name": "senderEmail",
            "value": "support@resellerA.com"
          }
        ],
        "group": "ive",
        "id": 0,
        "is_active": false,
        "is_default": false,
        "locale": [
          "nl_NL"
        ],
        "name": "",
        "tags": [
          {
            "key": "customer",
            "value": "Reseller A"
          }
        ]
      }
    ],
    "total": 999
  },
  "desc": ""
}