Skip to main content
POST
/
v1
/
connections
/
{connection_id}
/
sync-configs
Create sync configuration
curl --request POST \
  --url https://api.cuadra.ai/v1/connections/{connection_id}/sync-configs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "remoteResourceId": "<string>",
  "remoteResourceType": "<string>",
  "remoteResourcePath": "<string>",
  "targetDatasetId": "<string>",
  "syncFrequency": "manual",
  "autoCreateDataset": false
}
'
{
  "id": "<string>",
  "connectionId": "<string>",
  "name": "<string>",
  "remoteResourceId": "<string>",
  "remoteResourceType": "<string>",
  "syncFrequency": "manual",
  "status": "enabled",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "remoteResourcePath": "<string>",
  "targetDatasetId": "<string>",
  "lastSyncedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

JWT token from Stytch B2B authentication (magic link, SSO, or M2M)

Headers

​
Idempotency-Key
string | null

Path Parameters

​
connection_id
string
required

Connection ID

Body

application/json

Request to create a sync configuration.

​
name
string
required

User-friendly name: Marketing Docs

​
remoteResourceId
string
required

Provider's folder/database ID

​
remoteResourceType
string
required

Type: folder, database

​
remoteResourcePath
string | null

Human-readable path

​
targetDatasetId
string | null

Dataset to sync into

​
syncFrequency
enum<string>
default:manual

Sync frequency: manual, daily, weekly

Available options:
manual,
daily,
weekly
​
autoCreateDataset
boolean
default:false

If true and targetDatasetId is null, auto-creates a dataset

Response

Successful Response

Sync configuration.

​
id
string
required
​
connectionId
string
required
​
name
string
required
​
remoteResourceId
string
required
​
remoteResourceType
string
required
​
syncFrequency
enum<string>
required
Available options:
manual,
daily,
weekly
​
status
enum<string>
required
Available options:
enabled,
paused
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
remoteResourcePath
string | null
​
targetDatasetId
string | null
​
lastSyncedAt
string<date-time> | null