---
title: "PATCH /networks/{networkId}/settings"
method: PATCH
path: "/networks/{networkId}/settings"
---

# PATCH /networks/{networkId}/settings

`PATCH /networks/{networkId}/settings`

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

## Path parameters

- `networkId` string, required

## Request body

- object
  - `settings` object, required — Contains network-level configuration settings that apply to all users and security groups within a Wickr network.
    - `enableClientMetrics` boolean — Allows Wickr clients to send anonymized performance and usage metrics to the Wickr backend server for service improvement and troubleshooting.
    - `readReceiptConfig` object — Configuration for read receipts at the network level, controlling the default behavior for whether senders can see when their messages have been read.
      - `status` 'DISABLED' | 'ENABLED' | 'FORCE_ENABLED' — 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` object — 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.

## Response `200`

Success

- UpdateNetworkSettingsResponse
  - `settings` Setting[], required — A list of the updated network settings, showing the new values for each modified setting.
    - `optionName` string, required — The name of the network setting (e.g., 'enableClientMetrics', 'dataRetention').
    - `value` string, required — The current value of the setting as a string. Boolean values are represented as 'true' or 'false'.
    - `type` string, required — The data type of the setting value (e.g., 'boolean', 'string', 'number').

## Other responses

- `480` — ValidationError
- `481` — BadRequestError
- `482` — ResourceNotFoundError
- `483` — ForbiddenError
- `484` — UnauthorizedError
- `485` — InternalServerError
- `486` — RateLimitError

---

[API](https://skmtc.net/aws/apis/wickr.md) · [All operations](https://skmtc.net/aws/apis/wickr/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/wickr/versions/71d396c2af63/schema)