WickrAdminAPI / Client / update_network_settings

update_network_settings¶

WickrAdminAPI.Client.update_network_settings(**kwargs)¶

Updates network-level settings for a Wickr network. You can modify settings such as client metrics, data retention, and other network-wide options.

Request Syntax

response = client.update_network_settings(
    networkId='string',
    settings={
        'enableClientMetrics': True|False,
        'readReceiptConfig': {
            'status': 'DISABLED'|'ENABLED'|'FORCE_ENABLED'
        },
        'dataRetention': True|False,
        'enableTrustedDataFormat': True|False,
        'consentPopup': {
            'enabled': True|False,
            'header': 'string',
            'content': 'string',
            'closeButtonLabel': 'string'
        }
    }
)

Parameters:

networkId (string) –
[REQUIRED]

The ID of the Wickr network whose settings will be updated.
settings (dict) –
[REQUIRED]

A map of setting names to their new values. Each setting should be provided with its appropriate type (boolean, string, number, etc.).
- enableClientMetrics (boolean) –
  
  Allows Wickr clients to send anonymized performance and usage metrics to the Wickr backend server for service improvement and troubleshooting.
- readReceiptConfig (dict) –
  
  Configuration for read receipts at the network level, controlling the default behavior for whether senders can see when their messages have been read.
  - status (string) –
    
    The read receipt status mode for the network.
- dataRetention (boolean) –
  
  Indicates whether the data retention feature is enabled for the network. When true, messages are captured by the data retention bot for compliance and archiving purposes.
- enableTrustedDataFormat (boolean) –
  
  Configuration for OpenTDF integration at the network level, enforcing ABAC decision making when operating in TDF enabled rooms.
- consentPopup (dict) –
  
  Consent popup configuration for the network, displayed to users on login.
  - enabled (boolean) – [REQUIRED]
    
    Whether the consent popup is enabled. When set to true, the popup is displayed to users on login.
  - header (string) –
    
    Header text displayed at the top of the consent popup. Maximum 100 characters.
  - content (string) –
    
    Body content of the consent popup in Markdown format. Maximum 5000 characters.
  - closeButtonLabel (string) –
    
    Label for the close button on the consent popup. Maximum 20 characters. Defaults to “Acknowledge” if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'settings': [
        {
            'optionName': 'string',
            'value': 'string',
            'type': 'string'
        },
    ]
}

Response Structure

(dict) –
- settings (list) –
  
  A list of the updated network settings, showing the new values for each modified setting.
  - (dict) –
    
    Represents a single network-level configuration setting with its name, value, and data type. Settings control network-wide behaviors and features.
    - optionName (string) –
      
      The name of the network setting (e.g., ‘enableClientMetrics’, ‘dataRetention’).
    - value (string) –
      
      The current value of the setting as a string. Boolean values are represented as ‘true’ or ‘false’.
    - type (string) –
      
      The data type of the setting value (e.g., ‘boolean’, ‘string’, ‘number’).

Exceptions

WickrAdminAPI.Client.exceptions.ValidationError
WickrAdminAPI.Client.exceptions.BadRequestError
WickrAdminAPI.Client.exceptions.ResourceNotFoundError
WickrAdminAPI.Client.exceptions.ForbiddenError
WickrAdminAPI.Client.exceptions.UnauthorizedError
WickrAdminAPI.Client.exceptions.InternalServerError
WickrAdminAPI.Client.exceptions.RateLimitError