API - Planyo Web Services - send_email_to_customer

You are here: Planyo » Help » API » send_email_to_customer

send_email_to_customer

Description:

Allows you to send a message to the customer -- it's the same operation as clicking on Add new message on the reservation details page. The message being sent will be also registered in the history on that page for all administrators and the customer to see. Warning: this function will only work for sites with a custom SMTP server configured. If you use Planyo servers to send out your site's emails, this function will fail.

Input:

reservation_id int required
ID of the reservation for which the message is being sent
message_title string required
Email subject
message_content string required
Email body. The email body can contain all tags which are listed in the UI, such as tags from reservation-specific tags from Q204 or resource-specific tags from Q205, etc.
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

result string
success or failure depending on whether the SMTP server accepted the message for sending

API playground:

Click here to test this function in the API playground.