API - Planyo Web Services - delete_custom_property

You are here: Planyo » Help » API » delete_custom_property

delete_custom_property

Description:

Deletes a property by name. Properties can be of different types -- Planyo allows assigning custom properties to users, sites, resources and reservations.

Input:

type string required

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

id int required

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

name string required

Property name

method string required

must be set to delete_custom_property

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:

name string

The name of the deleted property.

API playground:

Click here to test this function in the API playground.