Child pages
  • cPanel API 1 Functions - Branding::setmyacctspkg

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function changes the branding package for a reseller and the reseller's accounts.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$set_accounts_package = $cpanel->api1('Branding', 'setmyacctspkg', array('package1', '0') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $set__accounts_package = $cpliveapi->api1('Branding', setacctspkg, ['package1', '0'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Branding::setmyacctspkg( $FORM('brandingpkg','allaccounts'))">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username Branding setmyacctspkg package1 0

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (none)
The function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
brandingpkgstring

Required

The branding package name.

A valid package name.package1
allaccountsBoolean

Whether to use this package for all of a reseller's accounts.

This value defaults to 0.

  • 1 — Change all of a reseller's accounts.
  • 0 — Change the current account's setting.
0

Returns

This function does not return output.