Sending Domains Calls

/settings/addSendingDomain

Add a new Sending Domains

            
{
    "owner_id":"example id",
    "token":"example token",
    "domain":"abc.com"
}  
            
            

{
    "status": "success",
    "message": "Sending Domain Added"
}

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters
owner_id* string	a valid SendCleanUser Id
token* string	a valid token
domain* string	domain name

* compulsory field

Return Value: Success
struct the results of newly Added Domain status string always success message string human readable message

Return Value: Error
struct the error results when attempt to add domain status string error message string human readable message type string one of the error type as bellow table

Error types
ValidationError	The parameters passed to the API call are invalid or not provided when required.
GeneralError	An unexpected errors occurred processing the request. SendCleanDevelopers will be notified.
AuthenticationError	Provided owner_id and token was not matched.

/settings/checkSendingDomain

check Sending Domain

            
{
    "owner_id":"example id",
    "token":"example token",
    "domain":"abc.com"
}  
            
            

{
    "status": "success",
    "domain": "abc.com",
    "dkim": {
                "valid": "Yes"
            },
    "spf":  {
                "valid": "No"
            },
    "valid_signing": "No"
}

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters
owner_id* string	a valid SendCleanUser Id
token* string	a valid token
domain* string	domain name

* compulsory field

Return Value: Success
struct the results of verify dkim and spf status string always success message string human readable message dkim[]struct dkim validation result valid string value is either 'Yes' OR 'No' spf[]struct spf validation result valid string value is either 'Yes' OR 'No' valid_signing string value is either 'Yes' OR 'No'

Return Value: Error
struct the error results when attempt verify dkim and spf status string error message string human readable message type string one of the error type as bellow table

Error types
ValidationError	The parameters passed to the API call are invalid or not provided when required.
GeneralError	An unexpected errors occurred processing the request. SendCleanDevelopers will be notified.
AuthenticationError	Provided owner_id and token was not matched.

/settings/verifySendingDomain

Verify Sending Domain

            
{
    "owner_id":"example id",
    "token":"example token",
    "domain":"abc.com",
    "mailbox":"john"
}  
            
            

{
    "status": "success",
    "message": "Verification instruction has been sent to john@abc.com"
}

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters
owner_id* string	a valid SendCleanUser Id
token* string	a valid token
domain* string	domain name
mailbox* string	mailbox name

* compulsory field

Return Value: Success
struct the results of Verify sending domain status string always success message string human readable message

Return Value: Error
struct the error results when attempt to verify Sending Domain status string error message string human readable message type string one of the error type as bellow table

Error types
ValidationError	The parameters passed to the API call are invalid or not provided when required.
GeneralError	An unexpected errors occurred processing the request. SendCleanDevelopers will be notified.
AuthenticationError	Provided owner_id and token was not matched.

/settings/listSendingDomain

List Sending Domain

            
{
    "owner_id":"example id",
    "token":"example token"
}  
            
            

{
    "status": "success",
    "sending_domain_list":[
                    {
                        "domain":"abc.com",
                        "create_date":67457775764,
                        "dkim": {
                                    "valid":"Yes"
                                },
                        "spf": {
                                    "valid":"Yes"
                                },
                        "verify_domain": {
                                    "valid":"Yes"
                                }
                    },
                    {
                        "domain":"xyz.com",
                        "create_date":67457775891,
                        "dkim": {
                                    "valid":"Yes"
                                },
                        "spf": {
                                    "valid":"Yes"
                                },
                        "verify_domain": {
                                    "valid":"No"
                                }
                    }
                    
                ]
}

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters
owner_id* string	a valid SendCleanUser Id
token* string	a valid token

* compulsory field

Return Value: Success

struct the results of List Sending Domain status string always success message string human readable message sending_domain_list[]struct information of single Sending Domain domain string domain name create_date integer create date in micro seconds dkim[]struct dkim validation result valid string value is Either 'Yes' OR 'No' spf[]struct spf validation result valid string value is Either 'Yes' OR 'No' verify_domain[]struct verify_domain validation result valid string value is Either 'Yes' OR 'No'

Return Value: Error
struct the error results when attempt to list Sending Domain status string error message string human readable message type string one of the error type as bellow table

Error types
ValidationError	The parameters passed to the API call are invalid or not provided when required.
GeneralError	An unexpected errors occurred processing the request. SendCleanDevelopers will be notified.
AuthenticationError	Provided owner_id and token was not matched.

/settings/deleteSendingDomain

Delete Sending Domain

            
{
    "owner_id":"example id",
    "token":"example token",
    "domain":"abc.com"
}  
            
            

{
    "status": "success",
    "message": "Sending Domain Deleted"
}

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters
owner_id* string	a valid SendCleanUser Id
token* string	a valid token
domain* string	domain name

* compulsory field

Return Value: Success
struct the results of Delete sending domain status string always success message string human readable message

Return Value: Error
struct the error results when attempt to Delete Sending Domain status string error message string human readable message type string one of the error type as bellow table

Error types
ValidationError	The parameters passed to the API call are invalid or not provided when required.
GeneralError	An unexpected errors occurred processing the request. SendCleanDevelopers will be notified.
AuthenticationError	Provided owner_id and token was not matched.