Create a source sync to execute

Beta

POST

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

POST

/v2/syncs

1 curl -X POST https://api-prod.scoutos.com/v2/syncs \
2      -H "Authorization: Bearer <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "sync_config": {
6     "source_settings": {
7       "source_archetype_id": "com.notion.notion",
8       "api_key": "api_key"
9     },
10     "destination": {
11       "destination_type": "collections.v2",
12       "collection_id": "collection_id",
13       "table_id": "table_id"
14     },
15     "mapping": {
16       "fields": [
17         {}
18       ]
19     },
20     "schedule": {
21       "frequency": "frequency",
22       "enabled": false
23     }
24   }
25 }'

Try it

200Successful

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

Request

This endpoint expects an object.

sync_configobjectRequired

Response

Successful Response

dataobject or nullOptional

Create a source sync to execute

Headers

Request

Response

Errors