reseller

is added when reseller has a customer specific business

Authenticate User

Description

Authenticates user.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of user
passwd String Required Password of user

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/user/authenticate.json?auth-userid=0&api-key=key&order-id=0&[email protected]&passwd=user-password

Response

Returns the details of a user if authenticated successfully.

Update Auto Responder

Note

This method will be deprecated on 30th march. All email accounts will be migrated to Open-Xchange and need to be managed from the Open-Xchange panel.

Description

Updates Auto Responder settings.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of user
is-autoresponder-on Boolean Required Values can be: true or false.
subject String Optional Subject of Auto Responder
message String Optional Message of Auto Responder
message-format String Optional Format of Auto Responder message. Values can be: text/plain or text/html.
quote-original-message Boolean Optional Values can be: true or false.
autodisable-enabled Boolean Optional Values can be: true or false. Pass true if you want Auto Reponder to be auto disabled.
autodisable-timestamp String Optional Date on which you want to disable Auto Responder. Format of value should be: dd/mm/yyyy e.g. 01/01/2011.

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/update-autoresponder.json?auth-userid=0&api-key=key&order-id=0&[email protected]&subject=subject-of-auto-responder&message=message-of-auto-responder&message-format=text/plain&quote-original-message=true&is-autoresponder-on=true

Response

Returns "SUCCESS" as the status if auto responder settings updated successfully.

Change Password

Description

Changes password of a user.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of user
old-passwd String Required Old password of user
new-passwd String Required New password of user

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/change-password.json?auth-userid=0&api-key=key&order-id=0&[email protected]&new-passwd=newpassword&old-passwd=oldpassword

Response

Returns "SUCCESS" as the status if password changed successfully.

Search Users

Description

Searches users based on the search criteria.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Optional Email address of user
email-pattern String Optional Regex pattern of email address
statuses String Optional Status of email account. Values can be: active, suspended and pending_activation.
account-types String Optional Type of email account. Values can be: pop_with_autoresponder, pop_with_auto_responder and forward_only.
over-quota Boolean Optional Values can be: true or false.
page-no Integer Optional Default value is 1. Each page contains max 200 records. E.g. Pass 2 as value if you want to fetch 201-400 records.

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/users/search.json?auth-userid=0&api-key=key&order-id=0

Response

Returns the details of the users matching the specified search criteria.

Unsuspend Users

Description

Unsuspends a list of users.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
emails String Required Comma-separated email addresses of users

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/users/unsuspend.json?auth-userid=0&api-key=key&order-id=0&[email protected],[email protected]

Response

Returns "SUCCESS" as the status if users unsuspended successfully.

Unsuspend User

Description

Unsuspends a user.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of user

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/unsuspend.json?auth-userid=0&api-key=key&order-id=0&[email protected]

Response

Returns "SUCCESS" as the status if a user unsuspended successfully.

Suspend Users

Description

Suspends a list of users.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
emails String Required Comma-separated email addresses of users

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/users/suspend.json?auth-userid=0&api-key=key&order-id=0&[email protected],[email protected]

Response

Returns "SUCCESS" as the status if users suspended successfully.

Suspend User

Description

Suspends a user.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of user

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/suspend.json?auth-userid=0&api-key=key&order-id=0&[email protected]

Response

Returns "SUCCESS" as the status if a user suspended successfully.

Modify User Details

Description

Modifies details of a user.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of a user
notification-email String Required Notification email address of a user
first-name String Required First name of a user
last-name String Required Last name of a user

HTTP Method

POST

Example Test URL Request


https://test.httpapi.com/api/mail/user/modify.json?auth-userid=0&api-key=key&order-id=0&[email protected]&[email protected]&first-name=firstname1&last-name=lastname1

Response

Returns "SUCCESS" as the status if user modified successfully.

Get User Details

Description

Gets the details of a user.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key String Required Authentication Parameter
order-id Integer Required Order ID of the Domain Registration, Email Hosting, Legacy Web Hosting, Website Builder, Enterprise Email or Digital Certificate Order
email String Required Email address of user

HTTP Method

GET

Example Test URL Request


https://test.httpapi.com/api/mail/user.json?auth-userid=0&api-key=key&order-id=0&[email protected]

Response

Returns the details of a user.

Subscribe to reseller