API - Planyo Web Services - set_custom_properties

You are here: Planyo » Help » API » set_custom_properties

set_custom_properties

Description:

Sets new values for multiple properties (max 50), of the type specified in the type parameter -- Planyo allows assigning custom properties to users, sites, resources and reservations. The property names (comma-separated) must be specified in the names parameter, and the values should be passed using the specified parameter names, e.g. if you set names to a,b,c then the values are passed as: ...&names=a,b,c&a=1&b=2&c=3

Please note that custom properties will be visible in the backend UI (for site administrators) unless the property name starts with 'hidden'. In such case the property will be usable only by the API and hidden everywhere in the UI. Note that normally for resource properties the language parameter should not be passed unless you're setting a language-specific property such as description.

Input:

type string required

Property type (one of: site, resource, reservation, user)

id int required

Related ID whose property is being queried (depending on type one of: site ID, resource ID, reservation ID, user ID)

names string required

Comma-separated property names. You then need to pass single name=value pairs as separate input parameters.

method string required

must be set to set_custom_properties

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:

names string

Comma-separated property names which were set

API playground:

Click here to test this function in the API playground.