Skip to main content
POST
Trigger App Sync

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_id
string
required

Body

application/json
sync_type
enum<string>
required

Which sync to run. Required. Today only full_sync (a full integration sync that re-pulls accounts, groups, and entitlements) is supported; any other value is rejected with 422. The field is required even with one value so the contract stays stable as more sync kinds are added.

Available options:
full_sync
Allowed value: "full_sync"

Response

Successful Response

app_id
string
required

UUID of the app (domain app) the sync was triggered for.

sync_type
enum<string>
required

The sync kind that was triggered (echoes the request).

Available options:
full_sync
Allowed value: "full_sync"
status
string
required

Sync state immediately after the trigger was accepted — typically SYNCING. The sync itself runs asynchronously; poll GET /apps/{app_id} to follow the app.