Syncs

Sync a folder

Sync a folder from Google Drive, Microsoft (OneDrive or SharePoint), Dropbox, Box, or Egnyte into a project's, account's, contact's, or intake's files, or the Library: pass exactly one of projectId, accountId, contactId, intakeId, or library, and folderId to place it inside a folder there. The sync uses your own connection to the provider, and Parley keeps the folder's files up to date in the background; they can't be changed in Parley. You sync a folder into a location once, while other people can sync the same folder there, each seeing what their own account can open: syncing it again into the same folder returns your existing sync, and into another folder of the location returns 409 FOLDER_ALREADY_SYNCED. Returns 409 CONNECTION_REQUIRED when you haven't connected the provider or must reconnect it, 400 INVALID_REFERENCE when the folder doesn't exist at the provider, isn't a folder, or your connection can't open it, and 429 TOO_MANY_REQUESTS when Egnyte's daily limit for your account is used up, until it resets at midnight UTC.

post/syncs

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/syncs
  • Auth
    HTTP bearer

Request body

projectIdstring

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

accountIdstring

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

contactIdstring

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

intakeIdstring

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

libraryunknown
folderIdstring

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

Response

Created.

idstring required

The sync ID.

status'pending' | 'active' | 'interrupted' | 'failed' 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.

reconnectRequiredboolean 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.

lastSyncedAtstring date-time nullable required

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

createdAtstring date-time required

When the sync was created.

updatedAtstring date-time required

When the sync last changed, including its status.

Changes

No recorded changes to this operation across all 2 revisions of this API.