Child pages
  • WHM API 1 Functions - update_integration_link_token
Skip to end of metadata
Go to start of metadata

This function refreshes the token for an integration link.


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/update_integration_link_token?api.version=1&user=username&app=WHMCS_billing&token=subway
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/update_integration_link_token?api.version=1&user=username&app=WHMCS_billing&token=subway
 Command Line
whmapi1 update_integration_link_token user=username app=WHMCS_billing token=subway


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. 

 Output (JSON)
{
   "data":{
   },
   "metadata":{
      "version":1,
      "reason":"Ok",
      "result":1,
      "command":"update_integration_link_token"
   }
}
 Output (XML)
<result>
    <data/>
    <metadata>
        <version>1</version>
        <reason>Ok</reason>
        <result>1</result>
        <command>update_integration_link_token</command>
    </metadata>
</result>


Note:

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

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account name.

A valid cPanel username.username
appstring

Required

The name of the application to link.

Note:

To update the name of the application in the interface, you must delete it and then recreate it with WHM API 1's create_integration_link function.

A valid string.WHMCS_billing
tokenstring

Required

The new access token to use for the application.

A valid string.subway

This function only returns metadata.