Create a source sync to execute

Beta

POST

https://api-prod.scoutos.com/v2/syncs

POST

/v2/syncs

1 from scoutos import (
2     CollectionDestination,
3     Mapping,
4     Scout,
5     SourceSyncGoogleDriveSettings,
6     SyncConfigInput,
7 )
8 
9 client = Scout(
10     api_key="YOUR_API_KEY",
11 )
12 client.syncs.create(
13     sync_config=SyncConfigInput(
14         source_settings=SourceSyncGoogleDriveSettings(),
15         destination=CollectionDestination(
16             collection_id="collection_id",
17             table_id="table_id",
18         ),
19         mapping=Mapping(),
20     ),
21 )

Try it

1 {
2   "data": {
3     "sync_config": {
4       "source_settings": {
5         "source_archetype_id": "com.google.drive"
6       },
7       "destination": {
8         "destination_type": "collections.v2",
9         "collection_id": "collection_id",
10         "table_id": "table_id"
11       },
12       "mapping": {
13         "fields": [
14           {}
15         ]
16       },
17       "schedule": {
18         "frequency": "frequency",
19         "enabled": false
20       }
21     },
22     "sync_id": "sync_id",
23     "trigger_id": "trigger_id",
24     "last_updated_at": "last_updated_at",
25     "created_at": "created_at",
26     "created_by": {
27       "type": "user",
28       "details": {
29         "user_id": "user_id",
30         "org_id": "org_id",
31         "scout_organization_id": "scout_organization_id",
32         "email": {}
33       }
34     },
35     "last_updated_by": {
36       "type": "user",
37       "details": {
38         "user_id": "user_id",
39         "org_id": "org_id",
40         "scout_organization_id": "scout_organization_id",
41         "email": {}
42       }
43     }
44   }
45 }

Request

This endpoint expects an object.

sync_configobjectRequired

Response

Successful Response

dataobject or null

Create a source sync to execute

Headers

Request

Response

Errors