Skip to main content
Set a transaction metadata key
curl --request PATCH \
  --url https://breadbox.example.com/api/v1/transactions/{id}/metadata/{key} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "value": "<unknown>"
}
'
{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Path Parameters

​
id
string
required

UUID or 8-char short_id.

​
key
string
required

Body

application/json
​
value
any
required

JSON value for the key (string, number, boolean, object, array, or null).

Response

Key set.

Last modified on June 5, 2026