Jump to

• Request
• Response
• Examples

Delete Email Domain Rules

delete

/rest/api/v1.3/settings/account/domains/email/{domainRuleType}/{domainName}

Deletes Email Domain Rules.

Request

Path Parameters

• domainName: string
  The domain name to be deleted.
• domainRuleType: string
  Domain rule type: avoidDomains, htmlDomains or txtDomains

  Allowed Values: [ "avoidDomains", "htmlDomains", "txtDomains" ]

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Delete email domain

Type: object

Title: Delete email domain

Show Source

• message: string
  Message regarding delete operation.
• status: boolean
  Status of the operation.

{
    "title":"Delete email domain",
    "type":"object",
    "properties":{
        "message":{
            "description":"Message regarding delete operation.",
            "type":"string"
        },
        "status":{
            "description":"Status of the operation.",
            "type":"boolean"
        }
    },
    "required":[
        "message",
        "status"
    ]
}

Back to Top

Examples

The following example shows how to delete Email Domain Rules.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Accept	application/json

Sample Request URL:

/rest/api/v1.3/settings/account/domains/email/htmlDomains/excite.com
	

Sample Response: Success

{
    "message": "The domain [excite.com] under [htmlDomains] deleted successfully.",
    "status": true
}
	

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