---
title: "Set a prop value"
method: PUT
path: "/api/v1/props/{id}/{key}"
tags: ["props"]
---

# Set a prop value

`PUT /api/v1/props/{id}/{key}`

Sets or updates a single property key for a sprout.

## Path parameters

- `id` string, required
- `key` string, required

## Request body

- object — The value to set for this property key.
  - `value` string — The property value to set

## Response `200`

Property set

- NATSEnvelope — Standard NATS proxy response envelope. On success, `result` contains the response data. On error, `error` contains a message string.
  - `result` unknown
  - `error` string — Error message (present only on failure)

## Other responses

- `400` — Bad request — missing or invalid parameters
- `502` — NATS communication error — farmer unreachable or returned an error

## Changes

- **2026-03-21** `011f9b67b17a` — 2 breaking, 3 info
  - the request's body type/format changed from ``/`` to `object`/``
  - the response's body type/format changed from ``/`` to `object`/`` for status `200`
  - added the new optional request property `value`
  - added the optional property `error` to the response with the `200` status
  - …1 more
- **2026-03-15** `1aab0676c2b4` — 2 breaking, 3 warning
  - the request's body type/format changed from `object`/`` to ``/``
  - the response's body type/format changed from `object`/`` to ``/`` for status `200`
  - removed the request property `value`
  - removed the optional property `error` from the response with the `200` status
  - …1 more
- **2026-03-13** `26871a2f667f` — 2 breaking, 3 warning
  - the request's body type/format changed from `object`/`` to ``/``
  - the response's body type/format changed from `object`/`` to ``/`` for status `200`
  - removed the request property `value`
  - removed the optional property `error` from the response with the `200` status
  - …1 more

[Change history](https://skmtc.dev/gogrlx/apis/grlx-cli-api/changes/api/v1/props/:id/:key/put.md)

---

[API](https://skmtc.dev/gogrlx/apis/grlx-cli-api.md) · [All operations](https://skmtc.dev/gogrlx/apis/grlx-cli-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gogrlx/grlx-cli-api/revisions/f88a30dcb10f/schema)