Key | Description |
name : string, mandatory | Name of the user type. |
personality_module : string, mandatory | The module api name for which the user type is to be configured. |
active : Boolean, optional | Represents whether the user type is active or inactive. The default value is false. |
modules : JSONArray, mandatory | The JSON array containing keys that describe the user type's settings for different modules that are linked to the personality module through look up or multi-lookup fields. |
modules.layouts.id : Number, mandatory | The layout the user type should be able to access. |
modules.permission : key value pairs, mandatory | Boolean key-value pairs that represent the permissions you want the users to have in the module. The possible keys are view, edit, create. |
modules.views : JSONObject, mandatory | The custom view or canvas view to display the records for the user type. |
modules.id: Number, mandatory | The related module id. |
modules.shared_type : String, mandatory | Represents whether the module is a private or public module. |
modules.filters : JSONObject,mandatory | Field id, by which the module record can be filtered for the user type. |
modules.fields : JSONArray, mandatory | Field permissions for the user type with read_only (Boolean), api_name(field API name) and id of the each field to be configured for the module. Note that if any of the fields in the layout is marked mandatory, they cannot be read-only in the portal. |
{ "user_type":[ { "name":"Customer", "personality_module":{ "api_name":"Customer" }, "active":true, "modules":[ { "layouts":[ { "id":"1306462000000095055" } ], "permissions":{ "view" : true }, "views":{ "id":"1306462000000091501", "type":"custom_view" }, "filters": null, fields": [ { "id": "18936550000000063924", "read_only": false } ], "id":"1306462000000000125", "shared_type":"private" }, { "layouts": null, "views": null, "filters": null, "permissions":{ "view":true }, "id":"1306462000000000147", "shared_type":"private" } ] } ] } |
{ "user_type": [ { "code": "SUCCESS", "details": { "id": "1306462000001856005" }, "message": "user type created successfully.", "status": "success" } ] } |
Key | Description |
name : string, optional | Name of the user type. |
personality_module : string, optional | The module api name for which the user type is to be configured. |
active : Boolean, optional | Represents whether the user type is active or inactive. The default value is false. |
modules : JSONArray, optional | The JSON array containing keys that describe the user type's settings for different modules that are linked to the personality module through look up or multi-lookup fields. |
modules.layouts.id : Number, optional | The layout the user type should be able to access. |
modules.permission : key value pairs, optional | Boolean key-value pairs that represent the permissions you want the users to have in the module. The possible keys are view, edit, create. |
modules.views : JSONObject, optional | The custom view or canvas view to display the records for the user type. |
modules.id: Number, optional | The related module id. |
modules.shared_type : String, optional | Represents whether the module is a private or public module. |
modules.filters : JSONObject, optional | Field id, by which the module record can be filtered for the user type. |
modules.fields : JSONArray, optional | Field permissions for the user type with read_only (Boolean), api_name(field API name) and id of the each field to be configured for the module. Note that if any of the fields in the layout is marked mandatory, they cannot be read-only in the portal. |
{ "user_type":[ { "modules":[ { "permissions":{ "edit":true, "create":true }, "id":"1306462000000000125", "shared_type":"private" } ] } ] } |
{ "user_type": [ { "code": "SUCCESS", "details": { "id": "1306462000001856005" }, "message": "Portal user type updated successfully.", "status": "success" } ] } |
{ "user_type": [ { "code": "SUCCESS", "details": { "id": 1306462000001857564 }, "message": "Portal user type deleted successfully.", "status": "success" } ] } |
Parameter | Description |
transfer_to : string, mandatory | The id of the user type to which you want to transfer the users. |
personality_ids : string, mandatory | comma separated list of ids of the users you want to transfer. |
{ "users": [ { "code": "SUCCESS", "details": { "personality_id": "1306462000000659009" }, "message": "User has been transferred successfully", "status": "success" } ] } |
Parameter | Description |
active : Boolean, mandatory | To mention whether to activate or deactivate the user. |
{ "change_status": [ { "code": "SUCCESS", "details": { "personality_id": "1306462000000665004" }, "message": "Status of the user changed successfully.", "status": "success" } ] } |
Parameter | Description |
personality_ids : string, mandatory | Comma separated ids of the users you want to delete from the portal. |
{ "users": [ { "code": "SUCCESS", "details": { "personality_id": "1306462000000659009" }, "message": "Portal user deleted successfully.", "status": "success" } ] } |
Writer is a powerful online word processor, designed for collaborative work.