---
title: "Run a V1 job"
method: POST
path: "/{env_id}/{flow_id}/{tenant}/jobs"
---

# Run a V1 job

`POST /{env_id}/{flow_id}/{tenant}/jobs`

Kicks off a job for a given tenant. When using the API tap, you can pass a payload in the `state` object to be written to the target. When `queue_if_active_job` is set to true in the request body, hotglue queues the job if another job is already running for the same tenant or flow.

## Path parameters

- `env_id` string, required
- `flow_id` string, required
- `tenant` string, required

## Request body

- object
  - `state` object — Pass extra context to be used in the job. Often used with the unified schema for write jobs. Note that this is different from the source state.
  - `tap` string — The source of the job. For write jobs, this is usually "api."
  - `job_name` string — Name for job. If not provided, name is autogenerated
  - `override_start_date` string, date-time — Date to start syncing data from (e.g. 2022-08-08T00:00:00.000Z)
  - `reset_source_state` boolean — Runs the job as a "full_sync" by clearing the `state` on the linkedSource
  - `streaming_job` boolean — If true, the job will run in streaming mode and skip the ETL step. This feature is in beta.
  - `override_selected_tables` object — For use with the unified schema. Define a temporary selection of unified schema objects to override the default selection. Does not affect your selection for future jobs. E.G. `{"Vendors":true}`
  - `override_field_map` object — Define a temporary field map to be used in the job, different from the configured field map.
  - `override_end_date` string, date-time — Date to sync data until (e.g. 2022-08-08T00:00:00.000Z). Note that `end_date` is only supported for certain connectors.
  - `override_source_config` object — Override the source connector configuration for this job only. Does not affect the saved configuration.
  - `override_target_config` object — Override the target connector configuration for this job only. Does not affect the saved configuration.
  - `ignore_parallel_jobs` boolean — If true, the job will ignore restrictions on parallel job execution for this connector.
  - `queue_if_active_job` boolean — If set to true, queues the job when another job is already running for the same tenant or flow. If omitted or set to false, the API returns an error when an active job blocks creation.
  - `environment_variables` object — Override environment variables for the job execution. Does not affect saved configuration.

## Response `200`

200

- object
  - `job_id` string
  - `env_id` string
  - `flow_id` string
  - `job_name` string
  - `tenant` string
  - `started_by` string
  - `s3_root` string
  - `start_time` string
  - `state` object
  - `tap` string
  - `status` 'JOB_CREATED' | 'DISCOVER_STARTED' | 'DISCOVER_FAILED' | 'SYNC_STARTED' | 'SYNC_FAILED' | 'SYNC_SUCCESS' | 'ETL_STARTED' | 'ETL_FAILED' | 'ETL_SUCCESS' | 'EXPORT_STARTED' | 'EXPORT_FAILED' | 'JOB_COMPLETED'
  - `scheduled_job` boolean
  - `message` string
  - `last_updated` string
  - `processed_rows` integer

## Other responses

- `202` — Job queued because another job is already running
- `400` — 400

---

[API](https://skmtc.net/hotglue/apis/hotglue-api.md) · [All operations](https://skmtc.net/hotglue/apis/hotglue-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hotglue/hotglue-api/versions/30ff54d01ec0/schema)