Beta

Create a source sync to execute

POST

1 from scoutos import (
2     CollectionDestination,
3     Mapping,
4     Scout,
5     SourceSyncNotionSettings,
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=SourceSyncNotionSettings(),
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.notion.notion"
6       },
7       "destination": {
8         "destination_type": "collections.v2",
9         "collection_id": "collection_id",
10         "table_id": "table_id"
11       },
12       "mapping": {},
13       "schedule": {
14         "frequency": "frequency",
15         "enabled": true
16       }
17     },
18     "sync_id": "sync_id",
19     "last_updated_at": "2024-01-15T09:30:00Z",
20     "created_at": "2024-01-15T09:30:00Z",
21     "created_by": {
22       "type": "user",
23       "details": {
24         "user_id": "user_id",
25         "org_id": "org_id",
26         "scout_organization_id": "scout_organization_id",
27         "email": {
28           "key": "value"
29         }
30       }
31     },
32     "last_updated_by": {
33       "type": "user",
34       "details": {
35         "user_id": "user_id",
36         "org_id": "org_id",
37         "scout_organization_id": "scout_organization_id",
38         "email": {
39           "key": "value"
40         }
41       }
42     },
43     "trigger_id": "trigger_id"
44   }
45 }

Request

This endpoint expects an object.

sync_configobjectRequired

Response

Successful Response

dataobjectOptional

Create a source sync to execute

Headers

Request

Response

Errors