Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function grants reseller status to an account.

Note:

This function grants reseller status to an existing account. You cannot create a new account with this function.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/setupreseller?user=username&makeowner=0
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/setupreseller?user=username&makeowner=0
 Command Line
whmapi0 setupreseller user=username makeowner=0 

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 0 documentation or run the whmapi0 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
   "result":[
      {
         "status":1,
         "statusmsg":null
      }
   ]
}
 Output (XML)
<setupreseller>
      <result>
            <status>1</status>
            <statusmsg/>
      </result>
</setupreseller>

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The account's username.

A valid username on the server.username
makeownerBoolean

Whether to set the account to own itself.

This parameter defaults to 0.

  • 1 — Make the account own itself.
  • 0 — Keep the account's current owner.
0

Returns

ReturnTypeDescriptionPossible valuesExample

result

array of hashes

An array of hashes of function output.

This hash includes the status and statusmsg returns.

 

status

Boolean

Whether the function succeeded.

The function returns this value in the result hash.

  • 1 — Success.
  • 0 — Failure.
1

statusmsg

string

A message of success or a reason for failure.

The function returns this value in the result hash.

  • null
  • An error message.

null