Jump to

• Request
• Response
• Examples

Add Email Domain Rules

put

/rest/api/v1.3/settings/account/domains/email

Adds new email domain rules to existing Email Domain Rules. Email Domain Rules are used during Campaign launch.

Request

Body ()

Request Body

Root Schema : Add Email Domain Rules Request

Type: object

Title: Add Email Domain Rules Request

Show Source

• avoidDomains: array avoidDomains
  List of email domains to which campaign messages must not be sent at all.
• htmlDomains: array htmlDomains
  List of domains that support only HTML based emails.
• txtDomains: array txtDomains
  List of domains that support only text based emails.

{
    "title":"Add Email Domain Rules Request",
    "type":"object",
    "properties":{
        "avoidDomains":{
            "description":"List of email domains to which campaign messages must not be sent at all.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "htmlDomains":{
            "description":"List of domains that support only HTML based emails.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "txtDomains":{
            "description":"List of domains that support only text based emails.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "avoidDomains",
        "htmlDomains",
        "txtDomains"
    ]
}

Nested Schema : avoidDomains

Type: array

List of email domains to which campaign messages must not be sent at all.

Show Source

• Array of: string

{
    "description":"List of email domains to which campaign messages must not be sent at all.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : htmlDomains

Type: array

List of domains that support only HTML based emails.

Show Source

• Array of: string

{
    "description":"List of domains that support only HTML based emails.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : txtDomains

Type: array

List of domains that support only text based emails.

Show Source

• Array of: string

{
    "description":"List of domains that support only text based emails.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The response includes a list of email domain rules that exist in the system after addition

Body ()

Root Schema : Email Domain Rules

Type: object

Title: Email Domain Rules

Show Source

• avoidDomains: string
  List of email domains to which campaign messages must not be sent at all
• htmlDomains: string
  List of domains that support only HTML based emails
• txtDomains: string
  List of domains that support only text based emails

{
    "title":"Email Domain Rules",
    "type":"object",
    "properties":{
        "avoidDomains":{
            "description":"List of email domains to which campaign messages must not be sent at all",
            "type":"string"
        },
        "htmlDomains":{
            "description":"List of domains that support only HTML based emails",
            "type":"string"
        },
        "txtDomains":{
            "description":"List of domains that support only text based emails",
            "type":"string"
        }
    },
    "required":[
        "avoidDomains",
        "htmlDomains",
        "txtDomains"
    ]
}

Back to Top

Examples

The following example shows how to add Email Domain Rules.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Accept	application/json

Sample Request URL:

/rest/api/v1.3/settings/account/domains/emails
	

Sample Request Body:

{
  "avoidDomains": "xyz.com",
  "htmlDomains": "hotmail.co.jp",
  "txtDomains": "abc.com"
}
	

Sample Response: Success

{
  "avoidDomains": "xyz.com",
  "htmlDomains": "hotmail.co.jp, yahoo.com, yahoo.co.jp",
  "txtDomains": "abc.com"
}
	

Example Response Failures

401 Unauthorized

User must be Account Admin: Requests fail when the user performing this request does not have the Account Admin role. The error resembles:

{
  "type": "",
  "title": "Insufficient access",
  "errorCode": "INSUFFICIENT_ACCESS",
  "detail": "User must be Account Admin.",
  "errorDetails": []
}
     

Back to Top