Share a calendar

This function adds a share for the specified calendar.

SecurityBasicAuth
Request
query Parameters
calendar
required
string

The calendar to share.

Example: calendar=calendar
delegatee
required
string

The person to whom you will share the calendar.

Example: delegatee=second@example.com
delegator
required
string

The owner of the calendar, who wishes to share it to another user.

Example: delegator=first@example.com
readonly
integer

If set, the provided access will be read-only.

Enum: 0 1
Example: readonly=1
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/add_delegate
Request samples
uapi --output=jsonpretty \
  --user=username \
  CPDAVD \
  add_delegate \
  delegator='first@example.com' \
  delegatee='second@example.com' \
  calendar='calendar'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "add_delegate",
  • "module": "CPDAVD",
  • "result": {
    • "data": {
      • "shared": 1
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}