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

 

Description

This function records a user's acceptance of the Technical Support Agreement (TSA). The cPanel Customer Portal stores each record with the user's login, the date and time, and the TSA's version.

 

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/ticket_update_service_agreement_approval?api.version=1&version=2010-04.v01.TSUPPORT
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/ticket_update_service_agreement_approval?api.version=1&version=2010-04.v01.TSUPPORT
 Command Line
whmapi1 ticket_update_service_agreement_approval version=2010-04.v01.TSUPPORT

 


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. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

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


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
versionstring

Required

The version of the TSA that the user approved.

Any non-empty string up to 32 characters.

2010-04.v01.TSUPPORT


Returns

This function only returns metadata.