Skip to main content
PATCH
/
v1
/
sync-configs
/
{config_id}
Update sync configuration
curl --request PATCH \
  --url https://api.cuadra.ai/v1/sync-configs/{config_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "syncFrequency": "manual",
  "status": "enabled",
  "targetDatasetId": "<string>"
}
'
{
  "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)

Path Parameters

​
config_id
string
required

Sync config ID

Body

application/json

Request to update sync configuration.

​
name
string | null
​
syncFrequency
enum<string> | null
Available options:
manual,
daily,
weekly
​
status
enum<string> | null
Available options:
enabled,
paused
​
targetDatasetId
string | null

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