---
title: "Update a box field"
method: POST
path: "/v1/boxes/{boxKey}/fields/{fieldKey}"
tags: ["Boxes"]
---

# Update a box field

`POST /v1/boxes/{boxKey}/fields/{fieldKey}`

## Request

- Base URL: `https://api.streak.com/api`
- URL: `https://api.streak.com/api/v1/boxes/{boxKey}/fields/{fieldKey}`
- Auth: HTTP bearer

Sets a custom field value. Omit value or send null to clear the field.

## Path parameters

- `boxKey` string, required
- `fieldKey` string, required

## Query parameters

- `overrideValidator` boolean

## Request body

- BoxFieldUpdateBody: The new value of a custom field.
  - `value` union: Field value. Omit or use null to clear the field.
    - string
    - boolean
    - number, double
    - string[]
    - BoxFormulaInput: Formula override for this box.
      - `formula` string, nullable: Formula text. An empty string restores the pipeline formula; null leaves the formula unchanged.

## Response `200`

Updated field value.

- BoxField: A custom field key and its current value.
  - `key` string, required: Key of the custom field.
  - `value` union: Current field value. Unset values are omitted.
    - string
    - boolean
    - integer
    - string[]
    - BoxFormulaField: A formula field and its most recent calculation result.
      - `calculationValue` unknown
      - `errorDetails` string, nullable: Reason the calculation failed, when available.
      - `calculationValueType` string, nullable: Type recorded for the calculated value.
      - `formula` string, nullable: Formula set on this box, when it overrides the pipeline formula.
      - `creationTimestamp` integer, nullable: Time the formula field was created, in epoch milliseconds.
      - `lastUpdatedTimestamp` integer, nullable: Time the formula was last changed, in epoch milliseconds.
      - `lastCalculatedTimestamp` integer, nullable: Time the formula was last calculated, in epoch milliseconds.
      - `calculationStatus` 'NOT_ATTEMPTED' | 'SUCCESS' | 'PENDING_WAITING_ON_DEPENDENCY' | 'FAILURE_SYNTAX' | 'FAILURE_RUNTIME' | 'FAILURE_BAD_REFERENCE' | 'FAILURE_CIRCULAR' | 'FAILURE_TIMEOUT' | 'FAILURE_DEPENDENT_ON_FAILED_FORMULA' | 'FAILURE_UNKNOWN_REASON' | 'FAILURE_NOT_SUPPORTED_RETURN_VALUE', required

## Changes

- **2026-10-17** `821356952e07`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/streakyc/apis/streak/changes/v1/boxes/:boxKey/fields/:fieldKey/post.md)

---

[API](https://skmtc.dev/streakyc/apis/streak.md) - [All operations](https://skmtc.dev/streakyc/apis/streak/llms.txt) - [OpenAPI document](https://skmtc.dev/streakyc/apis/streak/revisions/3648671fd1cf?raw)