API - Planyo Web Services - modify_site

Vous êtes ici: Planyo » Aide » API » modify_site



Use this function to make modifications to an existing site. You can modify any number of fields in a single call


site_id int optional
ID of the site. This is needed only for metasite API keys
name string optional
Site name
description string optional
Site description
use_shopping_cart bool optional
Set this to true if the shopping cart mode should be used or false otherwise.
prop_cal_xyz string optional
Custom site-level properties. E.g. for a custom property 'city', this would be prop_cal_city (use '_' in place of all space characters).
timezone string optional
Site's timezone. For full list, see Settings / Regional settings in the UI
date_format string optional
The date format. The only possible values are: 'Y/m/d', 'Y-m-d', 'd.m.Y', 'd M Y', 'M d, Y', 'm/d/Y'
time_format string optional
The time format. The only possible values are: 'H:i' (24-hour format), 'h:i a' (12-hour am/pm format)
default_language string optional
2-letter language code (e.g. EN, DE, FR etc.)
online_payment_surcharge float optional
Payment surcharge expressed in percent
allowed_domains string optional
Comma-separated domains where advanced integration is allowed for the site. The max number of domains is 10
notification_send_window float optional
The value of the UI option: Settings / Active fatures / Window of time for the notifications sent X days before arrival. This is expressed in full days. For example: 0.5 would mean 12 hours, 2 means 2 days.
method string required
must be set to modify_site
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.



API playground:

Click here to test this function in the API playground.