ver. 1684 (8b1f529)
services/apiref
services/apisrv
services/attrs
services/caches
services/caches/formatters
services/caches/map
services/caches/search
services/caches/shortcuts
services/logs
services/logs/images
services/oauth
services/replicate
services/users

Change the properties of a geocache
:: services/caches/edit method

Minimum Authentication: Level 3 (see Authentication Levels)
https://opencaching.pl/okapi/services/caches/edit

This method allows your users to change properties of an owned geocache. Currently, only the log password can be changed. Let us know if you need to edit other geocache properties.

cache_code required

Code of the geocache.

passwd optional

String - the new password for 'Found it' or 'Attended' log entries. If you supply an empty string, the password will be cleared, i.e. the geocache will not require a log password.

You may query the maximum accepted password length for the OC site by services/apsrv/installation. There may also be installation-dependent restrictions on which geocaches may have passwords. success will be false and an explanation message will be returned if a password is rejected.

langpref optional

Default value: en

Pipe-separated list of ISO 639-1 language codes. This indicates the order of preference in which language will be chosen for the messages return value.

format optional Standard common formatting argument.
callback optional Standard common formatting argument.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization.

Returned value:

A dictionary of the following structure:

  • success - boolean,

    • true if all of the supplied geocache properties were saved successfully or if no property to be changed was supplied. The geocache's last_modified date has been updated if any property was changed,
    • false if nothing was saved, which means that at least one of the supplied parameters was not acceptable.
  • messages - a dictionary of the supplied parameters that were not acceptable, each entry giving a plain-text string that explains the reason of rejection. The dictionary is empty in case of success.