STstreakyc
Boxes

Update a box field

Changed on

Sets a custom field value. Omit value or send null to clear the 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

Path parameters

boxKeystring required
fieldKeystring required

Query parameters

overrideValidatorboolean

Override blocking box validation rules when the current user has permission.

Request body

Response

Updated field value.

keystring required

Key of the custom field.

Example response

{
  "value": {
    "creationTimestamp": 1646870400000,
    "lastUpdatedTimestamp": 1646870400000,
    "lastCalculatedTimestamp": 1646870400000
  }
}

Changes