Force Sync

Force Sync

client.Apps.Connectors.ForceSync(ctx, connectorID, params) (*AppConnectorForceSyncResponse, error)

post/api/v1/apps/{app_id}/connectors/{connector_id}/force_sync

Invokes the c1.api.app.v1.ConnectorService.ForceSync method.

Parameters

connectorIDstring

The ConnectorID of the connector that we are forcing to sync.

paramsAppIDfieldBodyfieldAppConnectorForceSyncParams

Hide ParametersShow Parameters

AppIDfield

param.Field[string]

Path param: The AppID of the app the connector is attached to.

Bodyfield

optional

param.Field[any]

Body param: Signal the connector to start syncing. This puts the sync on the queue. It does not guarantee immediate sync. Long syncs still take minutes to hours.

Returns

AppConnectorForceSyncResponseinterface

The ForceSyncResponse message.

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Apps.Connectors.ForceSync(
    context.TODO(),
    "connector_id",
    conductoronesdk.AppConnectorForceSyncParams{
      AppID: "app_id",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

200 Example

{}