UpdateClientSettingsRequest

Request to update client settings for the tenant

Properties

Name	Type	Description
clientManager_Enabled	boolean	Whether the client manager field is enabled for clients
Whether the client manager field is enabled for clients
clientManager_Label	string	Optional custom label for the client manager field. Null means use the default.
Optional custom label for the client manager field. Null means use the default.
partner_Enabled	boolean	Whether the partner field is enabled for clients
Whether the partner field is enabled for clients
partner_Label	string	Optional custom label for the partner field. Null means use the default.
Optional custom label for the partner field. Null means use the default.
associate_Enabled	boolean	Whether the associate field is enabled for clients
Whether the associate field is enabled for clients
associate_Label	string	Optional custom label for the associate field. Null means use the default.
Optional custom label for the associate field. Null means use the default.
internalReference_Enabled	boolean	Whether the internal reference field is enabled for clients
Whether the internal reference field is enabled for clients
internalReference_ForceUnique	boolean	Whether to force internal references to be unique across all clients
Whether to force internal references to be unique across all clients
internalReference_AutoGenerate	boolean	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_Enabled	boolean	Whether external links are enabled for clients
Whether external links are enabled for clients
companiesHouse_Enabled	boolean	Whether the practice uses Companies House at all. Off disables every Companies House feature. Turn off for practices outside England and Wales.
Whether the practice uses Companies House at all. Off disables every Companies House feature. Turn off for practices outside England and Wales.
companiesHouseSync_Enabled	boolean	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. Ignored when SodiumHQ.DTOs.Client.UpdateClientSettingsRequest.CompaniesHouse_Enabled is off.
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. Ignored when SodiumHQ.DTOs.Client.UpdateClientSettingsRequest.CompaniesHouse_Enabled is off.
agentAuthorisations_Enabled	boolean	Whether the practice uses HMRC agent authorisations at all. Off hides the agent authorisations section on clients, the authorisation types on services, and the HMRC Agent settings page, and stops authorisation chase emails.
Whether the practice uses HMRC agent authorisations at all. Off hides the agent authorisations section on clients, the authorisation types on services, and the HMRC Agent settings page, and stops authorisation chase emails.
team_Enabled	boolean	Whether the team field is enabled for clients
Whether the team field is enabled for clients

JSON Example

{
  "clientManager_Enabled": false,
  "clientManager_Label": "string",
  "partner_Enabled": false,
  "partner_Label": "string",
  "associate_Enabled": false
}

Used By Operations

PUT Update client settings
/tenants/{tenant}/client-settings