Skip to main content
PATCH
/
api
/
syncs
/
{syncId}
Update a Sync
curl --request PATCH \
  --url https://sync.useparagon.com/api/syncs/{syncId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credentialId": "<string>"
}
'
{
  "id": "<string>",
  "data": {
    "credentialId": "<string>"
  },
  "message": "Update request accepted and is being processed"
}

Documentation Index

Fetch the complete documentation index at: https://docs.useparagon.com/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to update the credential associated with an existing Sync. This is useful if you are using Multi-Account Authorization and need to explicitly bind a Sync to an existing credential ID. After sending a request to this endpoint, the Sync that is updated will start a periodic full sync to reconcile its existing synced records with the records accessible in the new account.

Authorizations

​
Authorization
string
header
required

Paragon User Token. Add to the Authorization header of your requests.

Path Parameters

​
syncId
string
required

ID of the sync to update

Body

application/json
​
credentialId
string
required

The ID of the credential to associate with this sync. Must be a valid UUID.

Response

Sync successfully updated

​
id
string
required

ID of the updated sync

​
data
object
required
​
message
string
required
Example:

"Update request accepted and is being processed"