Replace transaction metadata
curl --request PUT \
--url https://breadbox.example.com/api/v1/transactions/{id}/metadata \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"metadata": {}
}'{
"error": {
"code": "<string>",
"message": "<string>"
}
}Replace transaction metadata
Atomically replace the entire free-form metadata JSONB object on a
transaction. Pass {} to clear all keys. Touches only the metadata
column. Requires full_access scope.
Replace transaction metadata
curl --request PUT \
--url https://breadbox.example.com/api/v1/transactions/{id}/metadata \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"metadata": {}
}'{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
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
UUID or 8-char short_id.
Body
application/json
Complete metadata replacement object.
Response
Replaced.
Last modified on June 5, 2026
⌘I