API - Planyo Web Services - add_notification_message

You are here: Planyo » Help » API » add_notification_message

add_notification_message

Description:

Adds site's notification email message.

Input:

notification_type string required

One of the following values. Please see FAQ222 for description of the values.
new_verified_reservation, reservation_confirmed, reservation_admin_canceled, reservation_user_canceled, reservation_admin_modified, reservation_auto_canceled, new_price_quotation, reservation_payment_received, reservation_user_modified, checked_in, checked_out, noshow, coupon_payment_received, reservation_products_user_modified, before_or_after_event_1, before_or_after_event_2, before_or_after_event_3, before_or_after_event_4, before_or_after_event_5, before_or_after_event_6.

Please note that sending of the notification needs to be actually turned on on the Settings / Email SMS notifications page.

recipient string required

One of the values: 'admin' - site admin, 'site_moder' - main site moderator, 'moder' - resource admin , 'user' - client

resource_id int optional

For resource-specific message, this is the resource ID

message-language string optional

Leave it empty to add a default message. For language-specific message, pass a two-letter language code (e.g. EN, DE, FR etc.)

subject string required

Message subject

body string required

Message body

from string optional

Pass either <empty> or 'sender_email'.
Leave the value empty to use our noreply@..... email address in the FROM field. In such case, your sender address or (if empty) site email address or the site owner address will be used in the REPLY-TO field.
When 'sender_email' is passed, the notifications sender email address defined on the Site settings page will be used in the FROM field. Please see FAQ188 in such case.

bcc string optional

Comma-separated list of BCC recipients

invoice_attachment string optional

Leave it empty when no invoice should be attached. In other case, the allowed value is 1 - for invoice in your language and 2 - for invoice in customer's language.

reservation_doc_1 string optional

One-based index of the reservation document defined in the site

reservation_doc_2 string optional

One-based index of the reservation document defined in the site

reply_to_customer string optional

For administrator recipients, pass '1' to set REPLY-TO to customer's email address whenever possible. Leave the value empty for the default behavior.

method string required

must be set to add_notification_message

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:

none

API playground:

Click here to test this function in the API playground.