set_parcel_info

From SmartBots Developers Docs
Jump to: navigation, search

Updates parcel details

Variables

The following table shows input values (you send them with the API call) and returned output values.

Variable Required Description.
Input basic parameters:
action yes = set_parcel_info
apikey yes Your personal developer's API key.
botname yes Your bot's SL login.
secret yes Bot access code of your bot.
dataType no Set to "json" to get JSON reply instead of URL-encoded string
custom no The custom data (string) to be passed back to caller script. This value will be returned back to the caller in HTTP response.
Input:
x no the X coordinate of the parcel (default - bot position)
y no the Y coordinate of the parcel (default - bot position)
entry yes the parcel entry to update (see the list below)
value yes the value to set
Output:
result OK - command completed successfully
FAIL - command failed
resulttext Detailed reason for the failure.
custom The value from input "custom" parameter. See above.

Available parcel entries

It is possible to update the following parcel entries. Set entry to:

  • name - set the name of parcel
    • value parameter - the new parcel name
  • description - set the parcel description
    • value parameter - the new parcel description
  • music_url - set the parcel music URL
    • value parameter - the new music URL
  • for_sale - make the parcel available for sale
    • value parameter format: on|off price
      • on - set parcel for sale
      • off - don't sell parcel
      • price - the parcel price (required but ignored for "don't sell");

Permissions

Your bot has to own the parcel, or have some of the permissions:

  • Parcel identity > "Change parcel name, description, and 'Moderate Content' setting"
  • Parcel settings > "Change music & media settings"
  • Parcel Management > "Set land for sale info"

Return values

The command returns result=OK if parcel update succeed.

IMPORTANT: there are no permissions check being done at the moment!


<< return back to Bot commands

(Miss an API call or parameter? Submit your request in forum)