We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • UAPI Functions - CCS::update_delegate
Skip to end of metadata
Go to start of metadata

Description

This function updates the delegation of a user's calendar to another user.

Note:

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

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/CCS/update_delegate?delegator=user1%20example.com&delegatee=user2%20example.com&readonly=1



Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Delegate user1 calendar to user2 on example.com
$delegate_calendar = $cpanel->uapi(
    'CCS', 'update_delegate',
    array(
        'delegator'        => 'user1@example.com',
        'delegatee'        => 'user2@example.com',
        'readonly'         => '1'
        )
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Delegate user1 calendar to user2 on example.com
my $delegate_calendar = $cpliveapi->uapi(
    'CCS', 'update_delegate',
    {
        'delegator'        => 'user1@example.com',
        'delegatee'        => 'user12example.com',
        'readonly'         => '1'
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 Command Line
uapi --user=username CCS update_delegate delegator=user1@example.com delegatee=user2@example.com readonly=1


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  
   }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
delegatorstring

Required

The calendar's owner.

A valid email address on the cPanel account.

user1@example.com
delegateestring

Required

The user to whom you delegated the calendar.

A valid email address on the cPanel account.

user2@example.com
readonlyBoolean

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

This parameter defaults to 0.

  • 1 — Read-only access.
  • 0 — Full access.
1

Returns

This function returns only metadata.