PATCH sync jobs cannot target relationships.

Author: SeaBlooms

examples/sync_job_workflow.py

@@ -9,6 +9,10 @@
 
 This is a standalone script that can be run independently to test
 the sync job functionality.
+
+Note: This example uses PATCH sync mode, which is suitable for entity-only
+uploads. If you need to upload relationships, use DIFF sync mode instead.
+See: https://docs.jupiterone.io/reference/pipeline-upgrade#patch-sync-jobs-cannot-target-relationships
 """
 
 import os
@@ -46,6 +50,7 @@ def main():
     try:
         # Step 1: Start sync job
         print("1. Starting synchronization job...")
+        print("   Note: Using PATCH mode (entities only). Use DIFF mode if uploading relationships.")
         sync_job = j1.start_sync_job(
             instance_id=instance_id,
             sync_mode="PATCH",

jupiterone/client.py

@@ -664,6 +664,13 @@ def start_sync_job(
             instance_id (str): The "integrationInstanceId" request param for synchronization job
             sync_mode (str): The "syncMode" request body property for synchronization job. "DIFF" or "PATCH"
             source (str): The "source" request body property for synchronization job. "api" or "integration-external"
+
+        Note:
+            IMPORTANT: PATCH sync jobs cannot target relationships. If your sync job involves creating
+            or updating relationships, you must use "DIFF" sync_mode instead of "PATCH". This is due
+            to the JupiterOne data pipeline upgrade.
+            
+            For more information, see: https://docs.jupiterone.io/reference/pipeline-upgrade#patch-sync-jobs-cannot-target-relationships
         """
         endpoint = "/persister/synchronization/jobs"