Edit a recurring series
curl --request PATCH \
--url https://breadbox.example.com/api/v1/series/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>"
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Requires full_access scope. Partial update of a thin series’ name and/or type — any subset may be present, omitted fields are unchanged. Renaming onto an existing live series name is rejected (the name is the series’ unique mint key). An empty body is rejected.
Edit a recurring series
curl --request PATCH \
--url https://breadbox.example.com/api/v1/series/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>"
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"type": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}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
Response
Updated series.
A thin, rule-maintained recurring series (subscription/bill/loan). Surrogate identity + name + type; membership comes from assign_series rules, not a shipped detector.
Last modified on June 24, 2026
⌘I