---
title: "Update a warehouse import"
method: PATCH
path: "/projects/{projectId}/warehouse-sources/imports/{importId}"
tags: ["Warehouse Imports"]
---

# Update a warehouse import

`PATCH /projects/{projectId}/warehouse-sources/imports/{importId}`

Update an existing warehouse import's settings.

### Patchable Fields

The following fields can be modified:

- **paused** (boolean, required): Pause or resume the import sync
- **run_every** (integer): Sync frequency in nanoseconds. Must be one of the following values:
  - `0`: API-triggered only (no scheduled sync)
  - `3600000000000`: Hourly
  - `86400000000000`: Daily
  - `604800000000000`: Weekly
- **databricks_params** (object): Databricks-specific cluster configuration (only for Databricks sources). Note: this is a full replacement, not a partial merge. Always provide the complete desired cluster configuration.

### Pause/Resume Behavior

- When `paused: true`, the import job will be stopped and no new syncs will be triggered
- When `paused: false`, the import job will be resumed with the specified frequency
- When resuming, you can optionally update `run_every`

### Databricks Configuration

For Databricks Jobs compute imports, you can update cluster configurations:
- `export_cluster_config`: Configuration for the data export job cluster

## Path parameters

- `projectId` integer, required
- `importId` integer, required

## Request body

- PatchWarehouseImportRequest
  - `paused` boolean, required — Whether to pause (true) or resume (false) the import
  - `run_every` 0 | 3600000000000 | 86400000000000 | 604800000000000, required — Sync frequency in nanoseconds. Only these values are accepted: - `0` - API-triggered only (use the manual-sync endpoint to trigger) - `3600000000000` - Hourly - `86400000000000` - Daily - `604800000000000` - Weekly
  - `databricks_params` DatabricksParams, nullable
    - `export_cluster_config` DatabricksClusterConfig, nullable
      - `spark_version` string — Spark runtime version (e.g., '15.4.x-scala2.12')
      - `node_type_id` string — Instance type for worker nodes (e.g., 'n2-standard-4' for GCP)
      - `driver_node_type_id` string, nullable — Instance type for driver node (defaults to node_type_id if not set)
      - `num_workers` integer — Fixed number of worker nodes
      - `autoscale` object, nullable — Autoscaling configuration (overrides num_workers if set)
        - `min_workers` integer
        - `max_workers` integer
      - `spark_conf` object, nullable — Spark configuration key-value pairs
      - `spark_env_vars` object, nullable — Environment variables (PYSPARK_PYTHON is always included)
      - `data_security_mode` 'USER_ISOLATION' | 'SINGLE_USER' | 'NONE' | 'LEGACY_TABLE_ACL' | 'LEGACY_PASSTHROUGH' | 'LEGACY_SINGLE_USER' | 'LEGACY_SINGLE_USER_STANDARD', nullable — Data security mode for the cluster
      - `single_user_name` string, nullable — Required if data_security_mode is SINGLE_USER
      - `custom_tags` object, nullable — Custom tags (provider=mixpanel is always added)
      - `policy_id` string, nullable — Cluster policy ID
      - `instance_pool_id` string, nullable — Instance pool ID for worker nodes
      - `driver_instance_pool_id` string, nullable — Instance pool ID for driver node
      - `enable_elastic_disk` boolean, nullable — Enable autoscaling local storage
      - `runtime_engine` 'STANDARD' | 'PHOTON', nullable — Runtime engine (STANDARD or PHOTON)
      - `aws_attributes` object, nullable — AWS-specific cluster configuration
      - `azure_attributes` object, nullable — Azure-specific cluster configuration
      - `gcp_attributes` object, nullable — GCP-specific cluster configuration
      - `init_scripts` object[], nullable — Cluster initialization scripts

## Response `200`

Success

- object
  - `status` 'ok' — "ok" if the request succeeded, "error" otherwise.
  - `results` WarehouseImportDetail
    - `id` integer
    - `import_type` 'event_sync' | 'event_stream' | 'people' | 'groups' | 'lookup_table'
    - `sync_mode` 'time_based' | 'mirror_mode' | 'full_sync' | 'one_time'
    - `created` string, date-time
    - `creator_id` integer
    - `creator_name` string
    - `creator_email` string
    - `warehouse_source_id` integer
    - `table_params` TableParams — Table location parameters (structure depends on warehouse type)
    - `paused` boolean
    - `run_every` 0 | 3600000000000 | 86400000000000 | 604800000000000 — Sync frequency in nanoseconds. Only these values are accepted: - `0` - API-triggered only (use the manual-sync endpoint to trigger) - `3600000000000` - Hourly - `86400000000000` - Daily - `604800000000000` - Weekly
    - `last_dispatch` integer, nullable
    - `is_deleted` boolean
    - `event_name` string, nullable
    - `event_column_name` string, nullable
    - `time_column_name` string, nullable
    - `user_column_name` string, nullable
    - `insert_time_column_name` string, nullable
    - `property_mappings` PropertyMappings, nullable
    - `group_key` string, nullable
    - `group_id_column` string, nullable
    - `databricks_params` DatabricksParams, nullable
      - `export_cluster_config` DatabricksClusterConfig, nullable
        - `spark_version` string — Spark runtime version (e.g., '15.4.x-scala2.12')
        - `node_type_id` string — Instance type for worker nodes (e.g., 'n2-standard-4' for GCP)
        - `driver_node_type_id` string, nullable — Instance type for driver node (defaults to node_type_id if not set)
        - `num_workers` integer — Fixed number of worker nodes
        - `autoscale` object, nullable — Autoscaling configuration (overrides num_workers if set)
          - `min_workers` integer
          - `max_workers` integer
        - `spark_conf` object, nullable — Spark configuration key-value pairs
        - `spark_env_vars` object, nullable — Environment variables (PYSPARK_PYTHON is always included)
        - `data_security_mode` 'USER_ISOLATION' | 'SINGLE_USER' | 'NONE' | 'LEGACY_TABLE_ACL' | 'LEGACY_PASSTHROUGH' | 'LEGACY_SINGLE_USER' | 'LEGACY_SINGLE_USER_STANDARD', nullable — Data security mode for the cluster
        - `single_user_name` string, nullable — Required if data_security_mode is SINGLE_USER
        - `custom_tags` object, nullable — Custom tags (provider=mixpanel is always added)
        - `policy_id` string, nullable — Cluster policy ID
        - `instance_pool_id` string, nullable — Instance pool ID for worker nodes
        - `driver_instance_pool_id` string, nullable — Instance pool ID for driver node
        - `enable_elastic_disk` boolean, nullable — Enable autoscaling local storage
        - `runtime_engine` 'STANDARD' | 'PHOTON', nullable — Runtime engine (STANDARD or PHOTON)
        - `aws_attributes` object, nullable — AWS-specific cluster configuration
        - `azure_attributes` object, nullable — Azure-specific cluster configuration
        - `gcp_attributes` object, nullable — GCP-specific cluster configuration
        - `init_scripts` object[], nullable — Cluster initialization scripts

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/mixpanel/apis/query-api.md) · [All operations](https://skmtc.net/mixpanel/apis/query-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mixpanel/query-api/revisions/f442da95252a/schema)
