Description

This function adds a profile to a Logaholic user.

Examples 


https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Logaholic&cpanel_jsonapi_func=adduserprofile&username=example&profile=newprofile

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Add profile "newprofile" to Logaholic user "example"
$add_logaholicuser = $cpanel->api2(
    'Logaholic', 'adduserprofile', 
    array(
        'username'       => 'example', 
        'profile'        => 'newprofile', 
    ) 
);

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Add profile "newprofile" to Logaholic user "example"
my $add_logaholicuser = $cpliveapi->api2(
    'Logaholic', 'adduserprofile',
    { 
        'username'      => 'example', 
        'profile'       => 'newprofile', 
    }
);

 

Because we removed this function before we introduced this functionality, you cannot call this function via the command line. 

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "adduserprofile",
    "data": [
      {
        "reason": "1 profile was created for 1 site example.com.",
        "result": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Logaholic"
  }
}

   

Parameters

ReturnTypeDescriptionPossible valuesExample
usernamestring

Required

The Logaholic username.

A valid string.example
profilestringRequired

The Logaholic profile's name.

A valid string.newprofile

Returns

ReturnTypeDescriptionPossible valuesExample
reason string

The status message from the function.

  • 1 profile was created for 1 site example.com.
  • An error message.
1 profile was created for 1 site example.com.
resultBooleanWhether the function succeeded.
  • 1 — The function succeeded.
  • 0 — The function failed.
 1
reasonstring

A reason for failure.

This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1