POST
/
sync
/
start
curl --request POST \
  --url https://api.nango.dev/sync/start \
  --header 'Content-Type: application/json' \
  --data '{
  "provider_config_key": "<string>",
  "connection_id": "<string>",
  "syncs": [
    "github-issues"
  ]
}'
{
  "success": true
}

Body

application/json
​
provider_config_key
string
required

The ID of the integration that you established within Nango.

​
syncs
required

A list of sync names that you wish to start.

Sync name

​
connection_id
string

The ID of the connection. If omitted, the syncs will be started for all relevant connections.

Response

200
application/json
Successfully started the sync
​
success
boolean
required

Was this page helpful?

Suggest editsRaise issue
Trigger sync(s)Pause sync(s)