Skip to content
Purser

Trigger Sync

POST
/connections/{connection_id}/sync
curl --request POST \
  --url https://example.com/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sync

Fetch now (archive-first, then import). Agents may trigger syncs.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
connection_id
required
Connection Id
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SyncOut
object
errors
required
Errors
Array<string>
gap_stats
Any of:
object
key
additional properties
integer
gap_windows
Gap Windows
integer
0
holdings_skipped_manual
Holdings Skipped Manual
integer
0
holdings_snapshots
Holdings Snapshots
integer
0
imported
required
Imported
integer
manual_period_rows_deleted
Manual Period Rows Deleted
integer
0
manual_period_tombstones
Manual Period Tombstones
integer
0
raw_fetch_id
required
Raw Fetch Id
string format: uuid
skipped
required
Skipped
integer
skipped_before_feed_start
Skipped Before Feed Start
integer
0
skipped_masked_duplicate
Skipped Masked Duplicate
integer
0
skipped_redescribed
Skipped Redescribed
integer
0
skipped_zero_amount
Skipped Zero Amount
integer
0
unmapped_accounts
required
Unmapped Accounts
integer
voided_pendings
required
Voided Pendings
integer

Example 

{
  "gap_windows": 0,
  "holdings_skipped_manual": 0,
  "holdings_snapshots": 0,
  "manual_period_rows_deleted": 0,
  "manual_period_tombstones": 0,
  "skipped_before_feed_start": 0,
  "skipped_masked_duplicate": 0,
  "skipped_redescribed": 0,
  "skipped_zero_amount": 0
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}