Skip to main content
PUT
/
sync
/
update-connection-frequency
Update sync frequency
curl --request PUT \
  --url https://api.nango.dev/sync/update-connection-frequency \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_config_key": "<string>",
  "connection_id": "<string>",
  "sync_name": "<string>",
  "frequency": "<string>",
  "sync_variant": "<string>"
}
'
{
  "frequency": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://nango.dev/docs/llms.txt

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

Requires an API key with the environment:syncs:manage scope. Learn more about API key scopes.

Authorizations

​
Authorization
string
header
required

The secret key from your Nango environment.

Body

application/json
​
provider_config_key
string
required

The ID of the integration you established within Nango

​
connection_id
string
required

The ID of the connection

​
sync_name
string
required

The name of the sync you want to update

​
frequency
string | null
required

The frequency you want to set (ex: 'every hour'). Set null to revert to the default frequency. Uses the https://github.com/vercel/ms notations. Min frequency: 30 seconds.

​
sync_variant
string

The variant of the sync you want to update

Response

Successfully updated the frequency

​
frequency
string

The updated frequency value