Jump to

• Request
• Response
• Examples

Get Email Domain Rules

get

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

Retrieves a list of Email domain rules for the account. Email domain rules are used when campaign messages are being sent out.
The response returns:

• The domains to which campaign messages must not be sent at all
• Domains to which HTML-format campaign mssages can be sent with confidence to recipients that will be able to read them
• Domains to which only plain-text campaign messages should be sent because recipients cannot read messages in any other format

See the Oracle Responsys Help Center for more information.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

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 retrieve an account's Email Domain Rules.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Accept	application/json

Sample Request URL:

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

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