Skip to main content
POST
Sync a folder

Authorizations

Authorization
string
header
required

A Parley API key.

Body

application/json
source
object
required

The folder to sync from a provider you've connected: the provider, and the folder's ID there.

projectId
string

Sync into this project's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

Minimum string length: 1
accountId
string

Sync into this account's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

Minimum string length: 1
contactId
string

Sync into this contact's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

Minimum string length: 1
intakeId
string

Sync into this intake's files. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

Minimum string length: 1
library
any

true for the organization's Library. Pass exactly one of projectId, accountId, contactId, intakeId, or library.

folderId
string

Put it inside this folder. Omit for the top level.

Minimum string length: 1

Response

Created.

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.