cPanel API 1 Functions - Branding::setbrandingpkg - Knowledgebase

Knowledgebase

Description

This function changes an account's branding package.

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

UAPI (recommended) — None.
cPanel API 2 — Branding::setbrandingpkgstatus — This function enables or disables the current branding package.

Examples

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

$set_branding_package = $cpanel->api1('Branding', 'setbrandingpkg', array('package1') ); // Call the function.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

my $set__branding_package = $cpliveapi->api1('Branding', 'setbrandingpkg', ['package1'] ); # Call the function.

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="Branding::setbrandingpkg( $FORM('brandingpkg'))">

Output (none)

This function does not return output

Parameters

Parameter	Type	Description	Possible values	Example
brandingpkg	string	Required The branding package name.	Any valid package name.	package1

Parameter

Type

Description

Possible values

Example

brandingpkg

string

Required

The branding package name.

Any valid package name.

package1

Returns

This function does not return output.

Knowledgebase

Categories

Categories