Skip to main content
POST
Update 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.

Path Parameters

id
string
required

The id of the object.

Example:

"sync_8Pq2Rs4tUv6wXy8zAb1cDe"

Body

application/json
name
string | null
Maximum string length: 80
enabled
boolean
accounts
string[]
Minimum array length: 1
account_mappings
object[]
options
object
metadata
object

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

Response

The updated sync

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"