---
updatedAt: 2026-09-01T14:06:31.000Z
agentTools:
  siteIndex: https://developer.jamf.com/llms.txt
  projectIndex: https://developer.jamf.com/platform-api/llms.txt
---

# Trigger sync run

Triggers a new sync operation for the specified connector. The sync runs asynchronously;
this endpoint returns immediately (`202 Accepted`). Poll `GET /sync/runs` to monitor
progress.

Conditions:
- Connector must be enabled (not disabled) — otherwise `409 Conflict`.
- Connector must be connected (credentials valid) — otherwise `422 Unprocessable Entity`.

Triggering is fire-and-forget: if a sync is already running the request is still accepted
(`202 Accepted`) and coalesced, rather than rejected.

Dispatching the run is a separate step from accepting the request and can be refused when the
service is at capacity — see `503 Service Unavailable`.


**Required Permissions:** `uem-connect:update`

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "JSC UEM Connect API",
    "version": "1.0.0",
    "description": "API for managing UEM Connect connectors",
    "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement/",
    "contact": {
      "name": "Jamf Developer",
      "url": "https://developer.jamf.com"
    }
  },
  "tags": [
    {
      "name": "sync-execution",
      "description": "Manage sync operations and view sync history"
    }
  ],
  "paths": {
    "/uem-connect/v1/connectors/{configId}/sync/runs": {
      "post": {
        "tags": [
          "sync-execution"
        ],
        "operationId": "triggerSync",
        "summary": "Trigger sync run",
        "x-action": true,
        "description": "Triggers a new sync operation for the specified connector. The sync runs asynchronously;\nthis endpoint returns immediately (`202 Accepted`). Poll `GET /sync/runs` to monitor\nprogress.\n\nConditions:\n- Connector must be enabled (not disabled) — otherwise `409 Conflict`.\n- Connector must be connected (credentials valid) — otherwise `422 Unprocessable Entity`.\n\nTriggering is fire-and-forget: if a sync is already running the request is still accepted\n(`202 Accepted`) and coalesced, rather than rejected.\n\nDispatching the run is a separate step from accepting the request and can be refused when the\nservice is at capacity — see `503 Service Unavailable`.\n\n\n**Required Permissions:** `uem-connect:update`",
        "parameters": [
          {
            "$ref": "#/components/parameters/X-Tenant-Id"
          },
          {
            "$ref": "#/components/parameters/X-Environment-Id"
          },
          {
            "$ref": "#/components/parameters/ConfigId"
          }
        ],
        "responses": {
          "202": {
            "description": "Sync triggered successfully, running asynchronously"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "409": {
            "$ref": "#/components/responses/Conflict"
          },
          "422": {
            "$ref": "#/components/responses/UnprocessableEntity"
          },
          "503": {
            "$ref": "#/components/responses/SyncDispatchRejected"
          }
        },
        "security": [
          {
            "oauth2": [
              "uem-connect:update"
            ]
          }
        ],
        "x-required-privileges": [
          "uem-connect:update"
        ]
      }
    }
  },
  "components": {
    "parameters": {
      "ConfigId": {
        "name": "configId",
        "in": "path",
        "required": true,
        "description": "The connector configuration identifier",
        "schema": {
          "type": "string",
          "example": "conn-abc123"
        }
      },
      "X-Tenant-Id": {
        "name": "X-Tenant-Id",
        "in": "header",
        "required": false,
        "description": "The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.",
        "schema": {
          "type": "string",
          "format": "uuid",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
          "example": "e77c1408-10c8-4007-b177-abc9157fbcaa"
        }
      },
      "X-Environment-Id": {
        "name": "X-Environment-Id",
        "in": "header",
        "required": false,
        "description": "The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.",
        "schema": {
          "type": "string",
          "format": "uuid",
          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
          "example": "e77c1408-10c8-4007-b177-abc9157fbcaa"
        }
      }
    },
    "schemas": {
      "ApiError": {
        "type": "object",
        "description": "Standard error object returned for all failed requests.",
        "required": [
          "httpStatus",
          "errors"
        ],
        "properties": {
          "httpStatus": {
            "type": "integer",
            "description": "The HTTP status code",
            "example": 422
          },
          "traceId": {
            "type": "string",
            "description": "Correlation identifier for the failed request",
            "nullable": true,
            "example": "80f198ee56343ba864fe8b2a57d3eff7"
          },
          "errors": {
            "type": "array",
            "description": "The individual problems with the request",
            "items": {
              "$ref": "#/components/schemas/ApiErrorEntry"
            }
          }
        }
      },
      "ApiErrorEntry": {
        "type": "object",
        "description": "A single problem with the request.",
        "required": [
          "description"
        ],
        "properties": {
          "code": {
            "type": "string",
            "description": "Machine-readable error code",
            "example": "CONNECTOR_NOT_CONNECTED"
          },
          "field": {
            "type": "string",
            "description": "The request field the error relates to, when applicable",
            "nullable": true,
            "example": "refreshRateMinutes"
          },
          "description": {
            "type": "string",
            "description": "Human-readable explanation",
            "example": "Connector 'conn-abc123' is not connected to the UEM platform"
          }
        }
      }
    },
    "responses": {
      "NotFound": {
        "description": "Not found — the referenced connector or resource does not exist. Error codes: `NOT_FOUND` — the referenced connector or resource does not exist for the tenant; `NO_ACTIVATION_PROFILE` — the tenant has no active activation profile to deploy (only emittable by `deployActivationProfile`). Not every code applies to every operation — check the individual operation's description.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiError"
            },
            "examples": {
              "notFound": {
                "summary": "Connector does not exist",
                "value": {
                  "httpStatus": 404,
                  "traceId": "80f198ee56343ba864fe8b2a57d3eff7",
                  "errors": [
                    {
                      "code": "NOT_FOUND",
                      "description": "Connector 'conn-abc123' was not found"
                    }
                  ]
                }
              },
              "noActivationProfile": {
                "summary": "No activation profile to deploy",
                "value": {
                  "httpStatus": 404,
                  "traceId": "80f198ee56343ba864fe8b2a57d3eff7",
                  "errors": [
                    {
                      "code": "NO_ACTIVATION_PROFILE",
                      "description": "No activation profile found for customer."
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "UnprocessableEntity": {
        "description": "Unprocessable entity. This API returns `422` for **both** schema-level and business-rule failures. Error codes: `VALIDATION_FAILED` — malformed JSON, a missing or mistyped required field, or a constraint violation (the `field` property identifies the offending body field where known); `VENDOR_MISMATCH` — the body `vendor` of an `updateSyncSettings` request does not match the connector's stored vendor; `CONNECTOR_NOT_CONNECTED` — the connector's credentials are not valid against the UEM platform; `CONNECTOR_MISCONFIGURED` — the UEM platform rejected the connector configuration.\nNote that connector creation can also fail with `400` when the connection test itself fails — see the `400` response on that operation.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiError"
            },
            "examples": {
              "validationFailed": {
                "summary": "Schema violation or malformed body",
                "value": {
                  "httpStatus": 422,
                  "traceId": "80f198ee56343ba864fe8b2a57d3eff7",
                  "errors": [
                    {
                      "code": "VALIDATION_FAILED",
                      "field": "autoDeviceDeletion",
                      "description": "must not be null"
                    }
                  ]
                }
              },
              "vendorMismatch": {
                "summary": "Body vendor does not match the stored connector",
                "value": {
                  "httpStatus": 422,
                  "traceId": "80f198ee56343ba864fe8b2a57d3eff7",
                  "errors": [
                    {
                      "code": "VENDOR_MISMATCH",
                      "description": "vendor 'INTUNE' in request body does not match stored vendor 'JAMF_PRO'"
                    }
                  ]
                }
              },
              "connectorNotConnected": {
                "summary": "Connector credentials not valid",
                "value": {
                  "httpStatus": 422,
                  "traceId": "80f198ee56343ba864fe8b2a57d3eff7",
                  "errors": [
                    {
                      "code": "CONNECTOR_NOT_CONNECTED",
                      "description": "Connector 'conn-abc123' is not connected to the UEM platform"
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "Conflict": {
        "description": "Conflict — the request cannot proceed against the current state of the tenant's connectors. Error codes: `CONNECTOR_DISABLED` — the connector is disabled (`triggerSync`, `deployActivationProfile`); `CONNECTOR_CONFIG_ALREADY_EXISTS` — the tenant already has a connector whose UEM vendor cannot coexist with the requested one, only Jamf Pro and Wizy may coexist (`createConnector`); `UNSUPPORTED_UEM_VERSION` — the UEM platform reported a version this integration does not support (`createConnector`); `MULTIPLE_ACTIVATION_PROFILES` — the tenant has more than one active activation profile, so the deployment target is ambiguous (`deployActivationProfile`). Not every code applies to every operation — check the individual operation's description.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiError"
            },
            "examples": {
              "connectorDisabled": {
                "summary": "Connector is disabled",
                "value": {
                  "httpStatus": 409,
                  "traceId": "80f198ee56343ba864fe8b2a57d3eff7",
                  "errors": [
                    {
                      "code": "CONNECTOR_DISABLED",
                      "description": "Connector 'conn-abc123' is disabled"
                    }
                  ]
                }
              },
              "connectorConfigAlreadyExists": {
                "summary": "Incompatible connector already exists",
                "value": {
                  "httpStatus": 409,
                  "traceId": "80f198ee56343ba864fe8b2a57d3eff7",
                  "errors": [
                    {
                      "code": "CONNECTOR_CONFIG_ALREADY_EXISTS",
                      "description": "A connector already exists for the customer with an incompatible UEM vendor."
                    }
                  ]
                }
              },
              "unsupportedUemVersion": {
                "summary": "UEM platform version not supported",
                "value": {
                  "httpStatus": 409,
                  "traceId": "80f198ee56343ba864fe8b2a57d3eff7",
                  "errors": [
                    {
                      "code": "UNSUPPORTED_UEM_VERSION",
                      "description": "UEM version is not supported."
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "SyncDispatchRejected": {
        "description": "Service unavailable — the sync could not be dispatched because the service's sync workers are saturated or the instance is shutting down. No sync run is left in progress, so the request can be retried. Error code: `SYNC_DISPATCH_REJECTED`.\n",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ApiError"
            },
            "example": {
              "httpStatus": 503,
              "traceId": "80f198ee56343ba864fe8b2a57d3eff7",
              "errors": [
                {
                  "code": "SYNC_DISPATCH_REJECTED",
                  "description": "The sync could not be dispatched. Please retry."
                }
              ]
            }
          }
        }
      }
    },
    "securitySchemes": {
      "oauth2": {
        "type": "oauth2",
        "description": "Obtain an access token by calling the API Gateway's token endpoint using the OAuth2 client-credentials flow.",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{region}.api.jamfcloud.com/auth/token",
            "scopes": {
              "uem-connect:create": "",
              "uem-connect:delete": "",
              "uem-connect:read": "",
              "uem-connect:update": ""
            }
          }
        }
      }
    }
  },
  "x-scope-types": [
    "tenant",
    "environment"
  ],
  "servers": [
    {
      "url": "https://{region}.api.jamfcloud.com/securitycloud",
      "description": "Jamf Beta API Gateway - prod",
      "variables": {
        "region": {
          "default": "us",
          "enum": [
            "us",
            "eu",
            "apac"
          ],
          "description": "Geographic deployment region"
        }
      }
    }
  ],
  "security": [
    {
      "oauth2": []
    }
  ]
}
```