API Method /calendars/modify
Modifies an existing calendar.
Arguments
- authentication
- This method requires user authentication.
- id string
- The ID of the calendar object to modify.
- calendar_name string
- The calendar name. (optional)
- description string
- The calendar description. (optional)
- tags string
- A space-delimited list of tags. (optional)
- privacy integer
- The privacy setting for this calendar. (1 = public, 2 = private, 3 = semi-private) (optional)
- where_query string
- Specified location to search in for smart calendar- the "where". (optional)
- what_query string
- The keywords to use for smart calendar - the "what". (optional)
- notify_schedule string
- Choice to notify owner on updates to calendar either "immediately", "daily", or "weekly". (optional)
-
Example Request
Here's an example request URL:
http://api.evdb.com/rest/calendars/modify?...&id=C0-001-000002272-8&tags=running+walking+jogging
Output Parameters
Output from this function is an XML block with the following constructs:
- status string
- ok
- idstring
- The calendar ID of the modified calendar.
- messagestring
- Calendar modified successfully.
Example XML Response
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<id>C0-001-000002272-8</id>
<message>Calendar modified successfully.</message>
</response>
Error Codes
This method may return these errors in an error document:
- Authentication error
- The specified user was not found or provided invalid credentials.
Missing parameter
- The 'id' parameter is mandatory.
- Not found
- There is no calendar with that identifier.
Write access denied
- You do not have permissions to edit this calendar
-