CPcpanel
DAV
Calendar and Contacts (DAV)

Manage a calendar, task list, or address book

Changed on

This function creates, updates, or deletes a collection.

get/CPDAVD/manage_collection

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

accountstring required
Example:user@example.com

The owner of the calendar.

action'create' | 'update' | 'delete' required
Example:delete

The action to perform (create, update, or delete a collection).

collection_type'calendar' | 'tasks' | 'addressbook' required
Example:calendar

The collection type.

calendar-colorstring
Example:#ee5555

The color of the calendar, if applicable.

descriptionstring
Example:This is my calendar.

The description of the collection.

namestring
Example:My Calendar

The name of the collection. Required when creating a collection.

pathstring
Example:/calendars/user@example.com/mycalendar

The path to the collection. Required for the update and delete actions, which use it to identify an existing collection. Optional for create, where omitting it autogenerates a path of the form <collection_type>-<uuid>.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "manage_collection",
  "module": "CPDAVD",
  "result": {
    "data": {
      "shared": 1
    },
    "status": 1
  }
}

Changes