Skip to main content
POST
Create a sync

Authorizations

Authorization
string
header
required

Authorization: Bearer rbk_live_...

Redbark-Version
string
header
required

The API release your integration is built against, e.g. 2026-10-01.wattle. Required on every request.

Body

application/json
destination
string
required
Example:

"dest_3Fg5Hj7kLm9nPq1rSt3uVw"

accounts
string[]
required
Minimum array length: 1
type
enum<string>

Default transactions

Available options:
transactions,
accounts,
holdings,
trades
name
string | null
Maximum string length: 80
mapping_mode
enum<string>

Sheets only: per_account writes each account to its own tab (created for you when account_mappings is omitted)

Available options:
bulk,
per_account
account_mappings
object[]

Required for YNAB (budget account per bank account); optional for Sheets per_account

category_mappings
object[]
rulesets
string[]
Maximum array length: 1
options
object
run_now
boolean

Queue the first run immediately (default true)

metadata
object

Up to 50 string pairs. Set a key to null to unset it.

Response

The created sync (latest_run is the queued first run)

id
string
required
Example:

"sync_8Pq2Rs4tUv6wXy8zAb1cDe"

object
enum<string>
required
Available options:
sync
name
string | null
required
type
required
Available options:
transactions,
accounts,
holdings,
trades
enabled
boolean
required
status
enum<string>
required
Available options:
idle,
running,
attention
attention
object | null
required
destination
object | null
required
accounts
string[]
required
account_mappings
object[]
required
options
object
required
rulesets
string[]
required
latest_run
object | null
required

include[]=latest_run

last_synced_at
string<date-time> | null
required
Example:

"2026-08-21T09:30:00.000Z"

metadata
object | null
required

Up to 50 string pairs. Set a key to null in an update to unset it.

livemode
boolean
required
created
string<date-time>
required
Example:

"2026-08-21T09:30:00.000Z"

updated
string<date-time>
required
Example:

"2026-08-21T09:30:00.000Z"