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.

See also: AWS API Documentation

Request Syntax

response = client.update_network_settings(
    networkId='string',
    settings={
        'enableClientMetrics': True|False,
        'readReceiptConfig': {
            'status': 'DISABLED'|'ENABLED'|'FORCE_ENABLED'
        },
        'dataRetention': True|False
    }
)
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.

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