Start sync(s)

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

POST

/sync/start

Starts the schedule of specified sync(s) for a given connection or all applicable connections if no connection is specified. Upon starting the schedule, the sync will execute immediately and then continue to run at the specified frequency. If the schedule was already started, this will have no effect.

Authorization

bearerAuth

headerAuthorizationBearer <token>

An Environment API key from your Tenklo environment, or an Account API key for account-level endpoints.

Request Body

application/json

body

provider_config_key*string

The ID of the integration that you established within Tenklo.

connection_id?string

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

syncs*array<>|array<>

Response Body

Successfully started the sync

application/json

response

success*boolean

Example Request

curl -X POST 'https://api.tenklo.dev/sync/start' \
  -H 'Content-Type: application/json' \
  -d '{
  "provider_config_key": "string",
  "syncs": [
    "string"
  ]
}'

Example Request

curl -X POST 'https://api.tenklo.dev/sync/start' \  -H 'Content-Type: application/json' \  -d '{  "provider_config_key": "string",  "syncs": [    "string"  ]}'

Example ResponseSchema

{
  "success": true
}

{  "success": true}

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Request Body

Response Body