Update account

Partially update mutable fields on a single account. Omit a key to leave the column unchanged. Send an explicit empty string to clear display_name.

Requires full_access scope.

Update account

cURL

curl --request PATCH \
  --url https://breadbox.example.com/api/v1/accounts/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "display_name": "<string>",
  "is_excluded": true,
  "is_dependent_linked": true,
  "owner_user_id": "<string>"
}
'

import requests

url = "https://breadbox.example.com/api/v1/accounts/{id}"

payload = {
    "display_name": "<string>",
    "is_excluded": True,
    "is_dependent_linked": True,
    "owner_user_id": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    is_excluded: true,
    is_dependent_linked: true,
    owner_user_id: '<string>'
  })
};

fetch('https://breadbox.example.com/api/v1/accounts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://breadbox.example.com/api/v1/accounts/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'display_name' => '<string>',
    'is_excluded' => true,
    'is_dependent_linked' => true,
    'owner_user_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://breadbox.example.com/api/v1/accounts/{id}"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"is_excluded\": true,\n  \"is_dependent_linked\": true,\n  \"owner_user_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://breadbox.example.com/api/v1/accounts/{id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"is_excluded\": true,\n  \"is_dependent_linked\": true,\n  \"owner_user_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://breadbox.example.com/api/v1/accounts/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"<string>\",\n  \"is_excluded\": true,\n  \"is_dependent_linked\": true,\n  \"owner_user_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "short_id": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "official_name": "<string>",
  "type": "<string>",
  "subtype": "<string>",
  "mask": "<string>",
  "iso_currency_code": "<string>",
  "balance_current": "<string>",
  "balance_available": "<string>",
  "balance_limit": "<string>",
  "is_excluded": true,
  "is_dependent_linked": true,
  "connection_id": "<string>",
  "user_id": "<string>",
  "owner_user_id": "<string>",
  "owner_user_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "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.

Body

application/json

display_name · string

Empty string clears the override.

is_excluded · boolean

is_dependent_linked · boolean

owner_user_id · string

short_id of a household member to own this account; empty string clears the override so it inherits the connection owner.

Response

200

application/json

Updated account.

id · string<uuid>

short_id · string

name · string

display_name · string | null

official_name · string | null

type · string

subtype · string | null

mask · string | null

iso_currency_code · string | null

balance_current · string | null

Decimal as string.

balance_available · string | null

balance_limit · string | null

is_excluded · boolean

is_dependent_linked · boolean

connection_id · string | null

user_id · string | null

short_id of the connection owner.

owner_user_id · string | null

short_id of the per-account owner override; null means the account inherits its connection owner.

owner_user_name · string | null

provider · enum<string>

Available options: plaid, teller, csv

created_at · string<date-time>

updated_at · string<date-time>