{ "portals": [ { "name": "ZylkerAutomobiles" } ] } |
Key | Description |
name | Unique name of the portal. |
{ "portals": [ { "code": "SUCCESS", "details": { "name": "ZylkerAutomobiles" }, "message": "Portal created successfully with given name.", "status": "success" } ] } |
{ "portals": [ { "name": "ZylkerAutos" } ] } |
Key | Description |
name | Unique name of the portal. |
{ "portals": [ { "created_time": "2023-02-07T20:13:20+05:30", "modified_time": "2023-02-07T20:13:20+05:30", "modified_by": { "name": "Patricia Boyle", "id": "4876876000000327001" }, "name": "ZylkerAutos", "active": true, "zaid": "10052946888", "created_by": { "name": "Patricia Boyle", "id": "4875876000000327001" } } ] } |
Key | Description |
name | The name of the portal |
active | Represents whether the portal is active or not. |
zaid | The unique id of the portal. |
{ "user_type": [ { "created_time": "2023-02-08T11:56:16+05:30", "default": true, "modified_time": "2023-02-08T11:56:16+05:30", "personality_module": { "plural_label": "Contacts", "api_name": "Contacts", "id": "1306462000000000129" }, "name": "Client Portal", "modified_by": { "name": "Patricia Boyle", "id": "1306462000083528405" }, "active": true, "id": "1306462000001813022", "created_by": { "name": "Patricia Boyle", "id": "1306462000083528405" }, "no_of_users": 1 } ] } |
Key | Description |
default | Represents whether the user type is the default one for the portal. |
personality_module | Details of the module for which the user type was configured. |
name | The name of the user type. |
active | Represents whether the user type is active or not. |
id | The unique id of the user type. |
no_of_users | The number of users in the portal assigned with this user type. |
Parameters | Parameter Description |
user_type_id : integer, mandatory | The id of the user type you want to assign the user with. |
type : string, mandatory | Represents whether the user is invited (invite) the first time or is re-invited(reinvite). |
language : string, optional | The language code of the user you want to invite to the portal |
{ "portal_invite": [ { "code": "SUCCESS", "details": { "record_id": "1306462000000659009" }, "message": "An Invite has been sent to the personality.", "status": "success" } ] } |
Parameters | Parameter Description |
type : string, optional | The type of user. Possible values are AllUsers, AllActiveUsers, ActiveUsers, DeactiveUsers, NotConfirmedUsers, ConfirmedUsers, and ActiveConfirmedUsers. |
filter : JSON object, optional | To filter based on the value disabled on updation of email of the status_reason__s field in the Users module. The allowed comparators are equal and not_equal. Note that you must encode this JSON object. |
{ "users": [ { "personality_id": "1306462000000659009", "confirm": true, "status_reason__s": null, "invited_time": "2023-02-08T18:03:10+05:30", "module": "Contacts", "name": "Jennifer Spears", "active": true, "email": "jennifer.spears@abc.com" } ], "info": { "per_page": 200, "total_count": 1, "count": 1, "page": 1, "more_records": false } } |
Key | Description |
personality_id | The id of the module for which the portal was created. |
confirm | Represents whether the user is a confirmed user or not. |
status_reason__s | The reason the user is disabled. |
module | The API name of the module for which the user type was created. |
name | The full name of the contact. |
active | Represents whether the user type is active or not. |
The email ID of the contact of that user type. |
Writer is a powerful online word processor, designed for collaborative work.