Black Friday promo up to -50% Time left:

Modify mail forward status

Description

Modify mail-forward's status


 Parameters

Name Data Type Status Description
auth-id or sub-auth-id or sub-auth-user Integer Required Authentication parameter
auth-password String Required Authentication parameter
domain-name String Required Domain name whose mail forwards you want to
mail-forward-id Integer Required Id of the mail-forward. You can list your mail-forwards by using List mail-forwards
status Integer Required It can be:
  • 0 - Paused
  • 1 - Active

Response: Array with mail forwards or failed status and status description.


Errors

When the authenctication of API user is not correct, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-password."}

In case the credentials of API sub user are invalid, the following status and statusDescription will be returned:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect sub-auth-id, sub-auth-user or auth-password."}

When invalid or non-existant domain-name is entered, the following status will be returned:

{"status":"Failed","statusDescription":"Missing domain-name"}

Note: These are example errors in JSON format.


 Example

URL JSON: https://api.cloudns.net/dns/modify-mail-forward-status.json
POST/GET:
auth-id=0&auth-password=password&domain-name=domain.com&mail-forward-id=1234&status=1
sub-auth-id=0&auth-password=password&domain-name=domain.com&mail-forward-id=1234&status=1


URL XML: https://api.cloudns.net/dns/modify-mail-forward-status.xml
POST/GET:
auth-id=0&auth-password=password&domain-name=domain.com&mail-forward-id=1234&status=1
sub-auth-id=0&auth-password=password&domain-name=domain.com&mail-forward-id=1234&status=1


Last modified: 2023-01-31
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more