---
title: "Update field settings"
method: POST
path: "/users/v1/fields/{id}/settings"
tags: ["Users"]
---

# Update field settings

`POST /users/v1/fields/{id}/settings`

## Request

- Base URL: `https://api.mitti.com`
- URL: `https://api.mitti.com/users/v1/fields/{id}/settings`
- Auth: HTTP bearer

## Path parameters

- `id` string, required

## Request body

- S12UsersUserfieldV1UserFieldServiceSetFieldSettingsBody
  - `settings` S12UsersUserfieldV1FieldSettings
    - `show_on_profile` boolean: Required. Flag to specify if the attribute is visible/configurable on the user profile
    - `allow_self_update` boolean: Required. Flag to specify if all users can update the attribute for their own account
    - `read_only` boolean: Read only. True when the field is system-managed and cannot be edited by users: allow_self_update is locked off and clients should render its toggle as disabled. Derived server-side from the set of read-only fields; ignored on write.

## Response `200`

A successful response.

- S12UsersUserfieldV1SetFieldSettingsResponse
  - `settings` S12UsersUserfieldV1FieldSettings
    - `show_on_profile` boolean: Required. Flag to specify if the attribute is visible/configurable on the user profile
    - `allow_self_update` boolean: Required. Flag to specify if all users can update the attribute for their own account
    - `read_only` boolean: Read only. True when the field is system-managed and cannot be edited by users: allow_self_update is locked off and clients should render its toggle as disabled. Derived server-side from the set of read-only fields; ignored on write.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/safetyculture/apis/safetyculture-api.md) - [All operations](https://skmtc.dev/safetyculture/apis/safetyculture-api/llms.txt) - [OpenAPI document](https://skmtc.dev/safetyculture/apis/safetyculture-api/revisions/eb6bb843bf18?raw)
