| Parameter name | Value | Description |
|---|---|---|
additionalFields |
object |
Additional fields for client details. |
additionalFields.title |
string |
Title of additional fields in client page. Max length: 255. |
additionalFields.fields |
list |
List of fields. |
additionalFields.fields[].id |
string |
Identifier of the field. |
additionalFields.fields[].name |
string |
Name of the field. Max length: 127. |
additionalFields.fields[].mandatory |
boolean |
The field is mandatory, or not. |
additionalFields.fields[].index |
integer |
Index order. |
contactPropertyMatching |
string |
Contact unique identifier. phoneNumber, emailAddress, clientReference. writable |
locationFiltering |
boolean |
List only contacts belonging to the staff's associated locations. Default value: false. writable |
locationAppointmentFiltering |
boolean |
Display appointments related to the staff's associated locations only. Default value: false. writable |
fieldColumns |
list |
Columns for contact list. Limited to 5 columns, ignored if more. Values: "name", "firstName", "lastName", "photo", "emailAddress", "phoneNumber", "tags", "city", "country", "jobTitle", "enterprise", "language", "birthDay", "misc1", "misc2", "misc3", "misc4", "misc5", "misc6", "misc7", "misc8", "misc9", "misc10". writable |
sync |
object |
Parameters for contact synchronization in external CRM Connectors. |
sync.clientLookup |
boolean |
Use CRM contact list to select contact. |
sync.createNewClient |
boolean |
Create new contacts in CRM. |
Authentication is required to execute this request. Please refer to Authentication for more.
Do not supply a request body with this method.
If successful, this method returns a Settings resource in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
In the request body, supply a Settings resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
additionalFields |
object |
Additional fields for client details. |
additionalFields.title |
string |
Title of additional fields in staff page. |
additionalFields.fields |
list |
List of fields. |
additionalFields.fields[].id |
string |
Identifier of the field. |
additionalFields.fields[].name |
string |
Name of the field. |
additionalFields.fields[].mandatory |
boolean |
The field is mandatory, or not. |
additionalFields.fields[].index |
boolean |
Index order. |
sync |
object |
Parameters for contact synchronization in external CRM Connectors. |
sync.clientLookup |
boolean |
Use CRM contact list to select contact. |
sync.createNewClient |
boolean |
Create new contacts in CRM. |
If successful, this method returns a Settings resource in the response body.