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

 

Description

This function sets an attribute for a cPanel Market provider's product.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/set_market_product_attribute?api.version=1&provider=cPStore&product_id=12345&attribute=price&value=6.00 
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/set_market_product_attribute?api.version=1&provider=cPStore&product_id=12345&attribute=price&value=6.00 
 Command Line
whmapi1 set_market_product_attribute provider=cPStore product_id=12345 attribute=price value=6.00 

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": "set_market_product_attribute"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>set_market_product_attribute</command>
    </metadata>
</result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
providerstring

Required

The cPanel Market provider's name.

A valid Market provider's name.cPStore
product_id
string

Required

The cPanel Market provider product's name.

A valid string.
12345
attribute
string

Required

The attribute of the cPanel Market provider's product.

A valid string.

Note:

Attributes vary between cPanel Market providers and products.

price
value
string

Required

The value to set for the attribute.

A valid string.
6.00

Returns

This function only returns metadata.