Update connector sync settings

put

https://{region}.api.jamfcloud.com/securitycloud/uem-connect/v1/connectors/{configId}/sync-settings

Updates the sync settings for the specified connector. Supported settings vary by UEM vendor.
Updated settings take effect on the next sync operation.

The vendor in the body must match the connector's stored vendor. It selects which
vendor-specific fields are applicable, not which connector is updated — the connector is
always identified by configId. A vendor that disagrees with the stored one is rejected
with 422 VENDOR_MISMATCH; the vendor of an existing connector cannot be changed through
this operation.

Required Permissions: uem-connect:update

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

configId

string

required

The connector configuration identifier

Body Params

Sync settings update request. Vendor-specific fields may also be included.
The vendor field in the body determines which additional fields are applicable.

This is a full replacement, not a patch: omitted optional fields are reset to their
defaults rather than left unchanged. Send the complete desired state.

Note the asymmetry with the response: autoDeviceDeletion and disableSyncOnAuthError are
top-level here, but are returned nested under syncConfig on ConnectorConfig.

vendor

string

enum

required

UEM vendor name — determines the shape of vendor-specific fields. Must match the stored
connector's vendor; a value that disagrees with it is rejected with 422 VENDOR_MISMATCH.
This field selects the applicable vendor-specific fields, it does not change which
connector is updated (that is the path configId) nor the connector's vendor.

refreshRateMinutes

int64

enum

60 to 1440

Defaults to 1440

Sync refresh interval in minutes.

Allowed:

scheduled

boolean

Defaults to true

Whether scheduled sync is enabled

autoDeviceDeletion

string

enum

required

Auto-deletion policy for devices removed from the UEM platform

Allowed:

disableSyncOnAuthError

boolean

Defaults to true

Whether to automatically disable sync after repeated authentication failures

groupSettings

object

Group mapping configuration. Maps UEM groups to JSC groups.

deviceFieldMappings

object

required

Controls which UEM attribute each JSC device field is populated from. Each value is an
enum of UEM attribute names whose members are vendor-specific, so the accepted values for
a given key depend on the connector's vendor. The Google connector accepts no mappings.

deviceRiskTagging

boolean

Defaults to false

Whether device risk levels are sent back to UEM

deviceUnmanagedThreshold

integer

enum

≥ 0

Defaults to 0

Number of days since last check-in before a device is treated as unmanaged.
0 uses the platform default (3 days). Not applicable for JAMF_PRO — any value
sent for that vendor is silently ignored (device status is taken exclusively from the UEM).

Allowed:

Headers

X-Tenant-Id

uuid

required

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier.

Responses

204

Sync settings updated successfully

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

415Unsupported media type — the request body Content-Type is not one this operation accepts, or it was omitted. Send application/json. Error code: UNSUPPORTED_MEDIA_TYPE.