Extensions can make use of Configuration Param API to access & modify the extension's config params. The available storage API's are,
- Add config params
- Get config param
#CONFIG_PARAM_API_REQUEST_OBJECT
- {
- "variables" : [
- {
- "name" : "configParam1",
- "value" : "value for the configparam 1"
- },
- {
- "name" : "configParam3",
- "value" : "value for the configparam 3"
- }
- ]
- }
#CONFIG_PARAM
- {
- "data" : [
- {
- "defaultValue" : "default1",
- "userDefined" : true,
- "name" : "variable1",
- "options" : "[op1, opt2]",
- "secure" : true,
- "type" : "text",
- "mandatory" : false,
- "value" : "testing",
- "varId" : "4000000011017"
- }
- ]
- }
Add or update config params
Use this API to add or update config params.
Request Format:
URL : https://desk.zoho.com/api/v1/installedExtensions/{{installationId}}/configParams
OAuth Scope : Desk.extensions.CREATE
RequestMethod : POST
RequestHeaders : orgId, Authorization
Content-Type : application/json
RequestBody : #CONFIG_PARAM_API_REQUEST_OBJECT.
Response Format:
ResponseCode : 200
Content-Type : application/json
Response : #CONFIG_PARAM_API_RESPONSE_OBJECT
Get config params
Use this API to get extension's config params.
Request Format:
URL : https://desk.zoho.com/api/v1/installedExtensions/{{installationId}}/configParams
OAuth Scope : Desk.extensions.READ
RequestMethod : GET
RequestHeaders : orgId, Authorization
Response Format:
ResponseCode : 200
Content-Type : application/json
Response : #CONFIG_PARAM_API_RESPONSE_OBJECT