Skip to main content
POST
Run a sync now

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The sync ID.

Minimum string length: 1

Response

OK

id
string
required

The sync ID.

Minimum string length: 1
location
object
required

Whose files these are: a project's, an account's, a contact's, or an intake's, or the organization's Library.

folder
object | null
required

The folder the synced folder is placed in, or null at the top level.

rootFolder
object | null
required

The folder in Parley that holds the synced files, or null until the first run creates it. Its files are listed and read like any others, but can't be changed in Parley.

source
object
required
status
enum<string>
required

pending: created, and its first run hasn't finished. active: syncing. interrupted: a run hit a problem Parley is resolving on its own. failed: it stopped syncing; delete it and sync the folder again.

Available options:
pending,
active,
interrupted,
failed
reconnectRequired
boolean
required

true when the connection the sync reads through stopped working. The sync doesn't run until the person who owns that connection reconnects it.

lastSyncedAt
string<date-time> | null
required

When a run last finished, or null before the first.

createdAt
string<date-time>
required

When the sync was created.

updatedAt
string<date-time>
required

When the sync last changed, including its status.