---
title: "Set a builtin license field value override for a given app and named field."
method: POST
path: "/app/{app_id}/builtin-license-field/{field_name}"
tags: ["apps"]
---

# Set a builtin license field value override for a given app and named field.

`POST /app/{app_id}/builtin-license-field/{field_name}`

## Request

- Base URL: `https://api.replicated.com/vendor/v3`
- URL: `https://api.replicated.com/vendor/v3/app/{app_id}/builtin-license-field/{field_name}`
- Auth: API key in header `Authorization`

Required RBAC Policy: kots/app/[:appid]/builtin-licensefields/update

## Path parameters

- `app_id` string, required
- `field_name` string, required

## Request body

- object
  - `is_locked` boolean: Whether the field should be locked. Optional.
  - `value` string, required: Value of the builtin license field that is to be overridden. Allows empty string.

## Response `200`

SetBuiltinLicenseFieldOverrideResponse contains the response of the builtin license field override

- object
  - `builtin_license_field` BuiltInDefaultLicenseField
    - `FieldName` string
    - `is_default` boolean
    - `is_hidden` boolean
    - `is_locked` boolean
    - `is_required` boolean
    - `title` string
    - `type` string
    - `value` string

## Other responses

- `400`: Returned on bad input
- `401`: Return if the caller is not authorized
- `403`: Returned if the caller does not have the needed permission
- `404`: Returned on resource not found

---

[API](https://skmtc.dev/replicated/apis/vendor-api-v3-2.md) - [All operations](https://skmtc.dev/replicated/apis/vendor-api-v3-2/llms.txt) - [OpenAPI document](https://skmtc.dev/replicated/apis/vendor-api-v3-2/revisions/a36c6aead22f?raw)