Pause or resume a connection

Toggles automated sync. Requires full_access scope.

Pause or resume a connection

cURL

curl --request POST \
  --url https://breadbox.example.com/api/v1/connections/{id}/paused \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "paused": true
}'

import requests

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

payload = { "paused": True }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({paused: true})
};

fetch('https://breadbox.example.com/api/v1/connections/{id}/paused', 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/connections/{id}/paused",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'paused' => true
  ]),
  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/connections/{id}/paused"

	payload := strings.NewReader("{\n  \"paused\": true\n}")

	req, _ := http.NewRequest("POST", 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.post("https://breadbox.example.com/api/v1/connections/{id}/paused")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"paused\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"paused\": true\n}"

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

200

{
  "id": "<string>",
  "short_id": "<string>",
  "user_id": "<string>",
  "institution_name": "<string>",
  "institution_id": "<string>",
  "paused": true,
  "sync_interval_seconds": 123,
  "last_sync_at": "2023-11-07T05:31:56Z",
  "next_sync_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

paused · boolean · required

Response

200 - application/json

Updated connection.

id · string

short_id · string

user_id · string

provider · enum<string>

Available options: plaid, teller, csv

institution_name · string | null

institution_id · string | null

status · enum<string>

Available options: active, error, pending_reauth, disconnected

paused · boolean

sync_interval_seconds · integer | null

last_sync_at · string<date-time> | null

next_sync_at · string<date-time> | null

created_at · string<date-time>

updated_at · string<date-time>