Update Auto Responder Settings for Email Users Using the API

When you want to update auto responder settings for an email user using the API. This article explains supported parameters, auto responder configuration options, auto-disable settings, and response details for email auto responder updates.

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=username@domainname.com&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.

Did you find this article helpful?