Overview
Module Name and Icons
Summary
Set module names(singular and plural), icon and color for modules
Request Arguments
Name |
Type |
Description |
Required |
language
|
string
|
The selected language for which the user is renaming (eg. en_us).
|
True
|
changedModules
|
array
|
List of module objects that are being modified
|
True
|
Response Arguments
Name |
Type |
Description |
modules
|
array
|
List of module objects that are being modified. Each array object consists of:
module_key: the module key
module_singular: the module singular name
module_plural: the module plural name
module_icon: the module icon (eg: sicon-account-lg)
module_color: the module color
|
Request Example
{
"language":"en_us",
"changedModules":[
{
"module_color": "coral",
"module_icon": "sicon-opportunity-lg",
"module_key": "Opportunities",
"module_name": "Opportunities",
"module_plural": "Deals",
"module_singular": "Deal",
},
],
}
Response Example
[
{
"module_key": "Opportunities",
"module_name": "Opportunities",
"module_singular": "Deal",
"module_plural": "Deals",
"module_color": "coral",
"module_icon": "sicon-opportunity-lg"
}
]
Change Log
Version |
Change |
v11_19
|
Added /Administration/module-names-and-icons/:language PUT endpoint.
|