Skip to main content

How it works

It is possible to add custom fields to the predefined user's fields set.

This can be useful for adding data to the user and thus saving custom information that are not part of the basic information provided by Selfcommunity.

Define the structure of the additional custom fields

Before you can start adding custom data to the user, it is necessary to define the structure of the additional custom fields. An example of a structure can be the following:

{
"company_name": {
"label": "Company name",
"mandatory": true
},
"company_website": {
"label": "Company website",
"type": "url"
},
"company_google_maps": {
"label": "Company Google Maps position url",
"type": "url"
},
"company_role": {
"label": "Role in the company",
"type": "enum",
"type_options": [
"Chief Executive Officer (CEO)",
"Chief Operating Officer (COO)",
"Chief Financial Officer (CFO) or Controller",
"Chief Marketing Officer (CMO)",
"Chief Technology Officer (CTO)",
"President",
"Vice President",
"Executive Assistant",
"Marketing manager",
"Product manager",
"Project manager",
"Finance manager",
"Human resources manager",
"Marketing specialist",
"Business analyst",
"Human resource personnel",
"Accountant",
"Sales representative",
"Customer service representative",
"Administrative assistant",
"Employee",
"Consultant"
]
},
"phone_number": {
"label": "Telephone",
"type": "phone_number"
}
}

Starting from this example it is possible to notice that to define the fields it is necessary to choose a field name (the key of the json dictionary) and the type of field among those available:

Types available

TypeDescription
stringA string (this is the default value for type and can be omitted in the metadata json definition
integerAn integer
phone_numberA phone number (eg: +39 376349****)
enumAn enumeration, it also needs a list of available options to be defined using "type_options".
urlAn URL
emailAn email

To define custom fields it is also possible to define a field label.

Update the user passing custom fileds

After defining the custom fields for the user you can finally pass them in the user PATCH

Patch a specific User

as if they were standard user fields.

Retrieve the user with custom fields

Now retrieving a user will resturn also the custom fields

get a specific User

as if they were standard user fields.