Child pages
  • WHM API 1 Functions - setupreseller
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?api.version=1&user=username&makeowner=0
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/setupreseller?api.version=1&user=username&makeowner=0
 Command Line
whmapi1 setupreseller user=username makeowner=0


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "metadata":{  
      "version":1,
      "reason":"OK",
      "command":"setupreseller",
      "result":1
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <command>setupreseller</command>
        <reason>OK</reason>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

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

This function only returns metadata.