API Docs / Schemas / UpdateClientSettingsRequest

UpdateClientSettingsRequest

Request to update client settings for the tenant

Properties

Name Type Description
clientManager_Enabledboolean

Whether the client manager field is enabled for clients

Whether the client manager field is enabled for clients

clientManager_ShowInListboolean

Whether to show the client manager in client lists

Whether to show the client manager in client lists

partner_Enabledboolean

Whether the partner field is enabled for clients

Whether the partner field is enabled for clients

partner_ShowInListboolean

Whether to show the partner in client lists

Whether to show the partner in client lists

associate_Enabledboolean

Whether the associate field is enabled for clients

Whether the associate field is enabled for clients

associate_ShowInListboolean

Whether to show the associate in client lists

Whether to show the associate in client lists

internalReference_Enabledboolean

Whether the internal reference field is enabled for clients

Whether the internal reference field is enabled for clients

internalReference_ShowInListboolean

Whether to show the internal reference in client lists

Whether to show the internal reference in client lists

internalReference_ForceUniqueboolean

Whether to force internal references to be unique across all clients

Whether to force internal references to be unique across all clients

internalReference_AutoGenerateboolean

Whether to auto-generate the internal reference from the client code on creation

Whether to auto-generate the internal reference from the client code on creation

externalLinks_Enabledboolean

Whether external links are enabled for clients

Whether external links are enabled for clients

companiesHouseSync_Enabledboolean

Whether Companies House auto-sync is enabled for this tenant. When off, the
Companies House worker does not queue stream events for any of this tenant's clients.

Whether Companies House auto-sync is enabled for this tenant. When off, the
Companies House worker does not queue stream events for any of this tenant's clients.

primaryContactName_ShowInListboolean

Whether to show the primary contact name in client lists

Whether to show the primary contact name in client lists

primaryContactEmail_ShowInListboolean

Whether to show the primary contact email in client lists

Whether to show the primary contact email in client lists

team_Enabledboolean

Whether the team field is enabled for clients

Whether the team field is enabled for clients

team_ShowInListboolean

Whether to show the team in client lists

Whether to show the team in client lists

JSON Example

{
  "clientManager_Enabled": false,
  "clientManager_ShowInList": false,
  "partner_Enabled": false,
  "partner_ShowInList": false,
  "associate_Enabled": false
}

Used By Operations