Perform an operation on a calendar or address book.

This function creates, updates, or deletes a collection.

SecurityBasicAuth

Request

query Parameters

account required	string The owner of the calendar. Example: account=user@example.com
action required	string The action to perform (create, update, or delete a collection). Enum: "create" "update" "delete" Example: action=delete
collection_type required	string The collection type. Enum: "calendar" "addressbook" Example: collection_type=calendar
path required	string The path to the collection. Example: path=/calendars/user@example.com/mycalendar
calendar-color	string The color of the calendar, if applicable. Example: calendar-color=#ee5555
description	string The description of the collection. Example: description=This is my calendar.
name	string The name of the collection. Required when creating a collection. Example: name=My Calendar

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/CPDAVD/manage_collection

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  CPDAVD \
  manage_collection \
  account='user@example.com' \
  action='delete' \
  path='/calendars/user@example.com/mycalendar' \
  collection_type='calendar'

Response samples

application/json

{"apiversion": 3,
"func": "manage_collection",
"module": "CPDAVD",
"result": {"data": {"shared": 1
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}