Upon sending this request, the sync will immediately start with the account that the user has connected.After the initial sync has completed, you will receive a sync_complete webhook event and records created / updated after the initial sync will send record_created or record_updated webhook events. Learn more about the Sync Lifecycle.
Using Multi-Account Authorization
If a user has connected multiple accounts of the same integration type (using Multi-Account Authorization), you can specify which account to use for syncing by providing the optional credentialId parameter in the request body.You can retrieve the list of connected credentials from the allCredentials array returned by the /sdk/me endpoint or paragon.getUser in the SDK.
If credentialId is not specified and the user has multiple connected accounts, the default credential (the oldest active credential) will be used.
The configuration for this sync. For example, the folder ID to sync from Google Drive. Learn more about the configuration options supported for each integration in the Integrations Reference.
The ID of the credential to use for syncing data. Use this when your user has connected multiple accounts for the same integration (Multi-Account Authorization). See Multi-Account Authorization for details on retrieving credential IDs.
If not provided, the default credential (oldest active credential) will be used.
INITIALIZING: The Sync has just been created and is pending its first run.
ACTIVE: The Sync is actively fetching new data.
IDLE: The Sync has completed and is watching for updates to synced data.
Check summary.lastSyncedAt to see if the sync has successfully completed.
RATE_LIMITED: The Sync is backing off because the third-party API's rate limit was reached. Check rateLimitBackoffMs for the back-off duration. The Sync resumes automatically once the back-off period passes.
DISABLED: The Sync has been paused temporarily by the Disable a Sync endpoint.
ERRORED: The Sync has been suspended due to an error. Check the errorCode, reason, and httpStatusCode fields on the Sync status for details, or Webhook Events for the sync_errored event.
DELETING: The Sync is being deleted and its synced data is being removed.
Available options:
INITIALIZING,
ACTIVE,
IDLE,
RATE_LIMITED,
DISABLED,
ERRORED,
DELETING
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Paragon Documentation","colors":{"primary":"#6645e6","light":"#6747e7","dark":"#6645e6"},"logo":{"light":"https://mintcdn.com/paragon/VsFfcYgo5-Qm6khT/logo/light.svg?fit=max\u0026auto=format\u0026n=VsFfcYgo5-Qm6khT\u0026q=85\u0026s=348909bc26f6451e89f4010d965f6e3f","dark":"https://mintcdn.com/paragon/VsFfcYgo5-Qm6khT/logo/dark.svg?fit=max\u0026auto=format\u0026n=VsFfcYgo5-Qm6khT\u0026q=85\u0026s=94df13e90b5d4116e55d031d5583fa1b","href":"https://docs.useparagon.com/"},"favicon":"https://mintcdn.com/paragon/jHdUQ3U2jexiiVjS/favicon.png?fit=max\u0026auto=format\u0026n=jHdUQ3U2jexiiVjS\u0026q=85\u0026s=92cb5c619d517e9c751282890f36033e","api":{"playground":{"proxy":false}},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://dashboard.useparagon.com/signup","label":"Sign up"}],"primary":{"type":"button","label":"Book a demo","href":"https://www.useparagon.com/book-demo"}},"footer":{"links":[{"header":"Home","items":[{"label":"Home","href":"https://www.useparagon.com"},{"label":"Sign Up","href":"https://dashboard.useparagon.com/signup"},{"label":"Book Demo","href":"https://www.useparagon.com/book-demo"},{"label":"Pricing","href":"https://www.useparagon.com/pricing"},{"label":"Careers","href":"https://www.useparagon.com/careers"}]},{"header":"Resources","items":[{"label":"Blog","href":"https://www.useparagon.com/blog"},{"label":"Case Studies","href":"https://www.useparagon.com/customers"},{"label":"ActionKit Playground","href":"https://try.actions.useparagon.com"},{"label":"Sync Playground","href":"https://try.sync.useparagon.com"},{"label":"Product Tour","href":"https://www.useparagon.com/product-tour-landing"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://www.useparagon.com/privacy-policy"},{"label":"Terms of Service","href":"https://www.useparagon.com/terms-of-service"},{"label":"Your Privacy Choices","href":"/optout"}]}]},"fonts":{"heading":{"family":"Helvetica Now Display Medium","weight":400,"source":"https://framerusercontent.com/assets/OKeqk0lRqQ5xtPOYZPiID295g.woff2","format":"woff2"}},"integrations":{"ga4":{"measurementId":"G-DH6VCLG1X6"},"gtm":{"tagId":"GTM-WCJFR4H"},"cookies":{"key":"paragon_docs_integrations_consent","value":"granted"}},"errors":{"404":{"redirect":false}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.useparagon.com/blog"},{"anchor":"Status","icon":"gear","href":"https://status.useparagon.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"paragon","hasAudioNarration":false,"actualSubdomain":"paragon","customDomains":["docs.useparagon.com"],"gitSource":{"type":"github","owner":"useparagon-internal","repo":"docs-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad7d4e9b58eb2be41615769","collectionId":"63c6be8a-dd8f-444a-80e2-d1daf2a79da2","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad7d4e9b58eb2be41615769"},"feedback":{"edits":false,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adbc92487ec42cfefdbabea","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Integrations Reference","count":1103},{"language":"default","tag":"ActionKit","count":1100},{"language":"default","tag":"Tools","count":863},{"language":"default","tag":"Triggers","count":147},{"language":"default","tag":"Integrations","count":126},{"language":"default","tag":"Integration Providers","count":126},{"language":"default","tag":"Managed Sync","count":67},{"language":"default","tag":"Platform","count":56},{"language":"default","tag":"Salesforce","count":51},{"language":"default","tag":"Dynamics 365 Sales","count":49}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#top-aligned-table td{vertical-align:top;padding:8px}#footer a[href='/optout']{overflow:auto;max-width:100%}footer>div{padding-top:4rem!important}a.nav-tabs-item[href=\"/resources/integrations\"]{margin-left:auto}div.nav-tabs{width:100%}"}],"page":{"pagePath":"managed-sync/api/enable-a-sync","slug":"/managed-sync/api/enable-a-sync","pageMetadata":{"openapi":"post /api/syncs","title":"Enable a Sync","description":"Start a Sync for a Connected User with a specific configuration","href":"/managed-sync/api/enable-a-sync"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Start a Sync for a Connected User with a specific configuration\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Accordion,Info}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!Info)_missingMdxReference(`Info`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Upon sending this request, the sync will immediately start with the account that the user has connected.`}),`\n`,_jsxs(_components.p,{children:[`After the initial sync has completed, you will receive a `,_jsx(_components.code,{children:`sync_complete`}),` webhook event and records created / updated after the initial sync will send `,_jsx(_components.code,{children:`record_created`}),` or `,_jsx(_components.code,{children:`record_updated`}),` webhook events. `,_jsx(_components.a,{href:`/managed-sync/sync-api`,children:`Learn more about the Sync Lifecycle`}),`.`]}),`\n`,_jsxs(Accordion,{title:`Using Multi-Account Authorization`,id:`using-multi-account-authorization`,children:[_jsxs(_components.p,{children:[`If a user has connected multiple accounts of the same integration type (using `,_jsx(_components.a,{href:`/apis/api-reference/multi-account-authorization`,children:`Multi-Account Authorization`}),`), you can specify which account to use for syncing by providing the optional `,_jsx(_components.code,{children:`credentialId`}),` parameter in the request body.`]}),_jsxs(_components.p,{children:[`You can retrieve the list of connected credentials from the `,_jsx(_components.code,{children:`allCredentials`}),` array returned by the `,_jsx(_components.a,{href:`/apis/api-reference/multi-account-authorization#getuser`,children:`/sdk/me`}),` endpoint or `,_jsx(_components.code,{children:`paragon.getUser`}),` in the SDK.`]}),_jsx(Info,{children:_jsxs(_components.p,{children:[`If `,_jsx(_components.code,{children:`credentialId`}),` is not specified and the user has multiple connected accounts, the default credential (the oldest active credential) will be used.`]})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /api/syncs","title":"Enable a Sync","description":"Start a Sync for a Connected User with a specific configuration","href":"/managed-sync/api/enable-a-sync"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/paragon/b66e6962cf6c82d8/cookiebot-mintlify-consent.js"],"openApiReferenceData":{"operation":{"summary":"Enable a Sync","description":"Start a Sync for a Connected User with a specific configuration","parameters":[],"requestBody":"05139c3a-6d67-48b3-85bc-9d024e1ec09d","responses":{"200":"eb469b19-9298-4348-b838-085b4edbe446","401":"6eb184b9-084c-46c0-8c57-d467e3f5bf80","404":"8ae76448-a178-40f2-b7d0-c86e9e360afd","409":"ad99ba3c-4221-4e76-9825-bf33313c5bf7"},"method":"post","type":"path","servers":["053cc851-2164-4406-8461-3cb85b4f6003"],"security":["cc4265ec-3360-4cbe-91a9-b673b823dbab"],"path":"/api/syncs","baseUrlOptions":["https://sync.useparagon.com"],"title":"Enable a Sync","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["integration","pipeline"],"properties":{"integration":{"type":"string","description":"The integration to use for the sync","example":"googledrive","isRequired":true,"uniqueKey":"integration","typeLabel":"string"},"pipeline":{"type":"string","description":"The type of Synced Object to sync from the integration. You can find the list of supported values in [Synced Objects](/managed-sync/synced-objects).","example":"files","isRequired":true,"uniqueKey":"pipeline","typeLabel":"string"},"configuration":{"type":"object","description":"The configuration for this sync. For example, the [folder ID](/managed-sync/integrations/googledrive) to sync from Google Drive. Learn more about the configuration options supported for each integration in the [Integrations Reference](/managed-sync/integrations/amazons3).","additionalProperties":true,"uniqueKey":"configuration","typeLabel":"object"},"configurationName":{"type":"string","description":"A unique name for this sync configuration. Set this field to a unique value when creating multiple syncs for the same integration and pipeline.","uniqueKey":"configurationName","typeLabel":"string"},"credentialId":{"type":"string","description":"The ID of the credential to use for syncing data. Use this when your user has connected multiple accounts for the same integration (Multi-Account Authorization). See [Multi-Account Authorization](/apis/api-reference/multi-account-authorization) for details on retrieving credential IDs.\n\nIf not provided, the default credential (oldest active credential) will be used.","uniqueKey":"credentialId","typeLabel":"string"},"incrementalAccumulatorFrequency":{"type":"string","enum":["1m","5m","10m","30m","1h","3h","6h","24h"],"description":"Controls how often Paragon checks for incremental changes from the integration for this sync. If not provided, the default frequency is used.\n\nUse a lower frequency (for example, `1h`) when freshness is less important than reducing API calls to the integration.","example":"1m","uniqueKey":"incrementalAccumulatorFrequency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"integration":"googledrive","pipeline":"files","configuration":{},"configurationName":"\u003cstring>","credentialId":"\u003cstring>","incrementalAccumulatorFrequency":"1m"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"eb469b19-9298-4348-b838-085b4edbe446":{"description":"Sync successfully enabled","content":{"application/json":{"schema":{"type":"object","required":["id","userId","integration","pipeline","projectId","status"],"properties":{"id":{"type":"string","description":"Unique identifier for the sync","example":"a11347bd-d510-5489-9068-e5fded55a28c","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"userId":{"type":"string","description":"ID of the Connected User who enabled the Sync","example":"your-user-id","isRequired":true,"uniqueKey":"userId","typeLabel":"string"},"integration":{"type":"string","description":"The integration to use for the sync","example":"googledrive","isRequired":true,"uniqueKey":"integration","typeLabel":"string"},"pipeline":{"type":"string","description":"The type of Synced Object being used in this Sync","example":"files","isRequired":true,"uniqueKey":"pipeline","typeLabel":"string"},"projectId":{"type":"string","description":"ID of the Paragon Project that this Sync is associated with","example":"1ea8024c-23a7-4885-b925-c50d0faf9318","isRequired":true,"uniqueKey":"projectId","typeLabel":"string"},"status":{"type":"string","enum":["INITIALIZING","ACTIVE","IDLE","RATE_LIMITED","DISABLED","ERRORED","DELETING"],"description":"Current state of Sync activity.\nPossible values:\n- `INITIALIZING`: The Sync has just been created and is pending its first run.\n- `ACTIVE`: The Sync is actively fetching new data.\n- `IDLE`: The Sync has completed and is watching for updates to synced data.\n\t- Check `summary.lastSyncedAt` to see if the sync has successfully completed.\n- `RATE_LIMITED`: The Sync is backing off because the third-party API's rate limit was reached. Check `rateLimitBackoffMs` for the back-off duration. The Sync resumes automatically once the back-off period passes.\n- `DISABLED`: The Sync has been paused temporarily by the [Disable a Sync](/managed-sync/api/disable-sync) endpoint.\n- `ERRORED`: The Sync has been suspended due to an error. Check the `errorCode`, `reason`, and `httpStatusCode` fields on the Sync status for details, or [Webhook Events](/managed-sync/webhooks) for the `sync_errored` event.\n- `DELETING`: The Sync is being deleted and its synced data is being removed.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"a11347bd-d510-5489-9068-e5fded55a28c","userId":"your-user-id","integration":"googledrive","pipeline":"files","projectId":"1ea8024c-23a7-4885-b925-c50d0faf9318","status":"INITIALIZING"}}},"exampleType":"generated"}},"exampleType":"generated"},"6eb184b9-084c-46c0-8c57-d467e3f5bf80":{"description":"Unauthorized","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"8ae76448-a178-40f2-b7d0-c86e9e360afd":{"description":"Source not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ad99ba3c-4221-4e76-9825-bf33313c5bf7":{"description":"A Sync already exists for this Connected User with the same integration, pipeline, credential, and configuration name. The response body includes the `id` of the existing Sync so you can resume working with it instead of creating a new one.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","message","id"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code","example":409,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","description":"Human-readable error message","example":"Sync instance already exists","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"id":{"type":"string","description":"ID of the existing Sync that conflicts with the create request. Use this ID to retrieve, update, disable, or delete the existing Sync.","example":"a11347bd-d510-5489-9068-e5fded55a28c","isRequired":true,"uniqueKey":"id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":409,"message":"Sync instance already exists","id":"a11347bd-d510-5489-9068-e5fded55a28c"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"cc4265ec-3360-4cbe-91a9-b673b823dbab":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paragon User Token. Add to the Authorization header of your requests.","scopes":[]}}},"servers":{"053cc851-2164-4406-8461-3cb85b4f6003":{"url":"https://sync.useparagon.com","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paragon User Token. Add to the Authorization header of your requests.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Paragon User Token. Add to the Authorization header of your requests.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"managed-sync/openapi.json"},"subdomain":"paragon","siteName":"Paragon Documentation","title":"Enable a Sync - Paragon Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-02T22:36:20.652Z","originalFileLocation":"managed-sync/api/enable-a-sync.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Start a Sync for a Connected User with a specific configuration\">\u003cmeta data-mint-head name=\"application-name\" content=\"Paragon Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Enable a Sync - Paragon Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start a Sync for a Connected User with a specific configuration\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Paragon Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.useparagon.com/managed-sync/api/enable-a-sync\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://paragon.mintlify.app/_mintlify/api/og/v2?division=Sync+API\u0026amp;title=Enable+a+Sync\u0026amp;description=Start+a+Sync+for+a+Connected+User+with+a+specific+configuration\u0026amp;theme=13788743c298c81ac0d08ae9\u0026amp;signature=eb2d7d6895ecb399bdaeb982f16836a78cf81b6d9ca2af310de02511e5b528e2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Enable a Sync - Paragon Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start a Sync for a Connected User with a specific configuration\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://paragon.mintlify.app/_mintlify/api/og/v2?division=Sync+API\u0026amp;title=Enable+a+Sync\u0026amp;description=Start+a+Sync+for+a+Connected+User+with+a+specific+configuration\u0026amp;theme=13788743c298c81ac0d08ae9\u0026amp;signature=eb2d7d6895ecb399bdaeb982f16836a78cf81b6d9ca2af310de02511e5b528e2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/paragon/jEl23Mfv0t0lim0x/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Paragon Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6645e6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.useparagon.com/managed-sync/api/enable-a-sync\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/managed-sync/api/enable-a-sync.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.useparagon.com/#organization\",\"name\":\"Paragon Documentation\",\"url\":\"https://docs.useparagon.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/paragon/VsFfcYgo5-Qm6khT/logo/light.svg?fit=max\u0026auto=format\u0026n=VsFfcYgo5-Qm6khT\u0026q=85\u0026s=348909bc26f6451e89f4010d965f6e3f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.useparagon.com#website\",\"name\":\"Paragon Documentation\",\"url\":\"https://docs.useparagon.com\",\"publisher\":{\"@id\":\"https://docs.useparagon.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.useparagon.com/managed-sync/api/enable-a-sync#webpage\",\"url\":\"https://docs.useparagon.com/managed-sync/api/enable-a-sync\",\"name\":\"Enable a Sync\",\"description\":\"Start a Sync for a Connected User with a specific configuration\",\"dateModified\":\"2026-07-02T22:36:20.652Z\",\"isPartOf\":{\"@id\":\"https://docs.useparagon.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.useparagon.com/managed-sync/api/enable-a-sync#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.useparagon.com/managed-sync/api/enable-a-sync#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sync API\",\"item\":\"https://docs.useparagon.com/managed-sync/sync-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Enable a Sync\",\"item\":\"https://docs.useparagon.com/managed-sync/api/enable-a-sync\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.useparagon.com/managed-sync/api/enable-a-sync#apireference\",\"headline\":\"Enable a Sync\",\"name\":\"Enable a Sync\",\"description\":\"Start a Sync for a Connected User with a specific configuration\",\"url\":\"https://docs.useparagon.com/managed-sync/api/enable-a-sync\",\"mainEntityOfPage\":{\"@id\":\"https://docs.useparagon.com/managed-sync/api/enable-a-sync#webpage\"},\"dateModified\":\"2026-07-02T22:36:20.652Z\",\"publisher\":{\"@id\":\"https://docs.useparagon.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.useparagon.com#website\"}}]}\u003c/script>","siteName":"Paragon Documentation","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://www.useparagon.com/blog"},{"anchor":"Status","icon":"gear","href":"https://status.useparagon.com/"}]},"tabs":[{"tab":"Platform","pages":[{"title":"Platform","href":"/overview"}]},{"tab":"Managed Sync","icon":"https://mintlify.s3.us-west-1.amazonaws.com/paragon/assets/sync-icon-light.svg","groups":[{"group":"Managed Sync","pages":[{"title":"Managed Sync","sidebarTitle":"Overview","href":"/managed-sync/overview"},{"title":"Getting Started","href":"/managed-sync/getting-started"},{"group":"Synced Objects","pages":[{"title":"Synced Objects","sidebarTitle":"Overview","href":"/managed-sync/synced-objects"},{"title":"File","icon":"file","href":"/managed-sync/api/file-schema"},{"title":"CRM Contact","icon":"user","href":"/managed-sync/api/contact-schema"},{"title":"CRM Company","icon":"building","href":"/managed-sync/api/company-schema"},{"title":"CRM Deal","icon":"money-bill","href":"/managed-sync/api/deal-schema"},{"title":"CRM Custom Object","icon":"cube","href":"/managed-sync/api/custom-object-schema"},{"title":"Ticket","icon":"ticket","href":"/managed-sync/api/ticket-schema"}]},{"title":"Monitoring Syncs","sidebarTitle":"Monitoring","href":"/managed-sync/monitoring"},{"title":"Webhooks","href":"/managed-sync/webhooks"}]},{"group":"Sync API","pages":[{"title":"Sync API","sidebarTitle":"Overview","description":"Learn how to use and implement Sync API in your app.","href":"/managed-sync/sync-api"},{"openapi":"post /api/syncs","title":"Enable a Sync","href":"/managed-sync/api/enable-a-sync"},{"openapi":"get /api/syncs/{syncId}","description":"Get the current status of a Sync","title":"Get Sync Status","href":"/managed-sync/api/get-sync-status"},{"openapi":"get /api/syncs/{syncId}/records","title":"Pull Synced Records","href":"/managed-sync/api/pull-synced-records"},{"openapi":"get /api/syncs/{syncId}/records/{recordId}","title":"Get Synced Record","href":"/managed-sync/api/get-synced-record"},{"openapi":"get /api/syncs/{syncId}/records/{recordId}/content","title":"Download File Content","href":"/managed-sync/api/download-content"},{"group":"Sync Management","icon":"gear","pages":[{"openapi":"get /api/syncs","title":"List Syncs","href":"/managed-sync/api/list-syncs"},{"openapi":"post /api/syncs/{syncId}/disable","title":"Disable a Sync","href":"/managed-sync/api/disable-sync"},{"openapi":"post /api/syncs/{syncId}/reenable","title":"Re-enable a Sync","href":"/managed-sync/api/reenable-sync"},{"openapi":"patch /api/syncs/{syncId}","title":"Update a Sync","href":"/managed-sync/api/update-sync"},{"openapi":"delete /api/syncs/{syncId}","title":"Delete a Sync","href":"/managed-sync/api/delete-sync"}]}]},{"group":"Permissions API","pages":[{"title":"Permissions API","sidebarTitle":"Overview","href":"/managed-sync/permissions-api"},{"openapi":"post /api/permissions/{syncId}/check","title":"Check Access","href":"/managed-sync/api/check-access"},{"openapi":"post /api/permissions/{syncId}/batch-check","title":"Batch Check Access","href":"/managed-sync/api/batch-check-access"},{"openapi":"post /api/permissions/{syncId}/list-users","title":"List Users","href":"/managed-sync/api/list-users"},{"openapi":"post /api/permissions/{syncId}/list-objects","title":"List Objects","href":"/managed-sync/api/list-objects"},{"openapi":"post /api/permissions/{syncId}/streamed-list-objects","title":"Streamed List Objects","href":"/managed-sync/api/streamed-list-objects"},{"openapi":"post /api/permissions/streamed-list-objects","title":"Streamed List Objects (All Syncs)","href":"/managed-sync/api/streamed-list-objects-all-syncs"},{"openapi":"post /api/permissions/{syncId}/expand","title":"Expand Relationships","href":"/managed-sync/api/expand"},{"openapi":"get /api/permissions/{syncId}/changes","title":"Permission Changes","href":"/managed-sync/api/permission-changes"}]},{"group":"Integrations Reference","pages":[{"group":"File Storage","pages":[{"title":"Amazon S3","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/amazons3.svg","href":"/managed-sync/integrations/amazons3"},{"title":"Box","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/box.svg","href":"/managed-sync/integrations/box"},{"title":"Confluence","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/confluence.svg","href":"/managed-sync/integrations/confluence"},{"title":"Contentful","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/contentful.svg","href":"/managed-sync/integrations/contentful"},{"title":"Dropbox","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/dropbox.svg","href":"/managed-sync/integrations/dropbox"},{"title":"Google Drive","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/googledrive.svg","href":"/managed-sync/integrations/googledrive"},{"title":"Guru","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/guru.svg","href":"/managed-sync/integrations/guru"},{"title":"Intercom","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/intercom.svg","href":"/managed-sync/integrations/intercom"},{"title":"OneDrive","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/onedrive.svg","href":"/managed-sync/integrations/onedrive"},{"title":"Microsoft Teams","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/microsoftTeams.svg","href":"/managed-sync/integrations/microsoft-teams"},{"title":"Notion","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/notion.svg","href":"/managed-sync/integrations/notion"},{"title":"ServiceNow","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/servicenow.svg","href":"/managed-sync/integrations/servicenow"},{"title":"SharePoint","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/sharepoint.svg","href":"/managed-sync/integrations/sharepoint"},{"title":"Zendesk","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/zendesk.svg","href":"/managed-sync/integrations/zendesk"}]},{"group":"CRM","pages":[{"title":"Dynamics 365 Sales","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/microsoftDynamics.svg","href":"/managed-sync/integrations/microsoftDynamics"},{"title":"HubSpot","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/hubspot.svg","href":"/managed-sync/integrations/hubspot"},{"title":"NetSuite","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/netsuite.svg","href":"/managed-sync/integrations/netsuite"},{"title":"Pipedrive","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/pipedrive.svg","href":"/managed-sync/integrations/pipedrive"},{"title":"Salesforce","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/salesforce.svg","href":"/managed-sync/integrations/salesforce"},{"title":"Zoho CRM","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/zohocrm.svg","href":"/managed-sync/integrations/zohocrm"}]},{"group":"Ticketing","pages":[{"title":"Asana","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/asana.svg","href":"/managed-sync/integrations/asana"},{"title":"ClickUp","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/clickup.svg","href":"/managed-sync/integrations/clickup"},{"title":"Freshdesk","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/freshdesk.svg","href":"/managed-sync/integrations/freshdesk"},{"title":"Intercom","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/intercom.svg","href":"/managed-sync/integrations/intercom"},{"title":"Jira","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/jira.svg","href":"/managed-sync/integrations/jira"},{"title":"Monday.com","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/monday.svg","href":"/managed-sync/integrations/monday.com"},{"title":"ServiceNow","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/servicenow.svg","href":"/managed-sync/integrations/servicenow"},{"title":"Zendesk","icon":"https://cdn.useparagon.com/latest/dashboard/public/integrations/zendesk.svg","href":"/managed-sync/integrations/zendesk"}]}]}]},{"tab":"ActionKit","icon":"https://mintlify.s3.us-west-1.amazonaws.com/paragon/assets/actions-icon-light.svg","pages":[{"title":"ActionKit","href":"/actionkit/overview"}]},{"tab":"Workflows","icon":"https://mintlify.s3.us-west-1.amazonaws.com/paragon/assets/workflow-icon-light.svg","pages":[{"title":"Workflows","href":"/workflows/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/resources/integrations"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/apis/api-reference"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/tutorials/building-an-in-app-integrations-catalog"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/changelog/product-updates"}]}]},"title":"Enable a Sync - Paragon Documentation","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}