API - Planyo Web Services - do_reservation_action

Planyo » Pomoc » API » do_reservation_action

do_reservation_action (version 0.2)

Description:

Call to perform an administrative action (such as confirmation or cancellation) on a reservation

Input:

reservation_id int required

ID of the reservation

action string required

One of: Verify (email address verified), Confirm, Preapprove (automatically confirm this and all future reservations of this user), Fraud (cancel this reservation and prevent this user to make future reservations), Cancel (reservation cancelled by the administrator), User_cancel (reservation cancelled by the user)

custom_data string optional

If action is verify, this is the verification code (required). In other cases this is ignored

version float optional

you can optionally specify the version of the API that you're using. Use the value of latest or simply skip this parameter to use the latest API version. The latest version is: 0.2

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

Output:

status ReservationStatus

New (updated) status of the reservation

user_text string

Text to be displayed to the user with the status of their reservation