Add calendar delegation

This function delegates a user's calendar to another user.

Note:

You must install the Calendar and Contacts Server cPanel plugin to access this API function.

Authorizations:
query Parameters
delegatee
required
string <email>

The user to whom you wish to delegate the calendar.

Example: delegatee=delegatee@cptest.test
delegator
required
string <email>

The calendar's owner.

Example: delegator=delegator@cptest.test
readonly
integer
Default: 0

Whether the delegatee will only have read-only access on the calendar.

  • 1 - Read-only access.
  • 0 - Full access.
Enum: 1 0
Example: readonly=1

Responses

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

Request samples

uapi --output=jsonpretty \
  --user=username \
  CCS \
  add_delegate \
  delegator='delegator@cptest.test' \
  delegatee='delegatee@cptest.test'

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "add_delegate",
  • "module": "CCS",
  • "result": {
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}