---
title: "POST /api/transform"
method: POST
path: "/api/transform"
tags: ["/api/transform"]
---

# POST /api/transform

`POST /api/transform`

Create a new transform.

## Request body

- object
  - `collection_id` integer, nullable — value must be an integer greater than zero.
  - `description` string, nullable
  - `name` string, required
  - `owner_email` string, nullable
  - `owner_user_id` integer, nullable — value must be an integer greater than zero.
  - `run_trigger` 'none' | 'global-schedule'
  - `source` union, required
    - object
      - `query` unknown, required
      - `source-incremental-strategy` MetabaseTransformsSchemaSourceIncrementalStrategy
        - `checkpoint-filter-field-id` integer — Valid Field ID
        - `type` 'checkpoint', required
      - `type` 'query', required
    - object
      - `body` string, required
      - `source-database` integer
      - `source-incremental-strategy` MetabaseTransformsSchemaSourceIncrementalStrategy
        - `checkpoint-filter-field-id` integer — Valid Field ID
        - `type` 'checkpoint', required
      - `source-tables` MetabaseTransformsBaseUtilSourceTableEntry[], required
        - `alias` string, required
        - `database_id` integer, required
        - `schema` string, nullable, required
        - `table` string
        - `table_id` integer, nullable
      - `type` 'python', required
  - `tag_ids` integer[]
  - `target` union, required
    - MetabaseTransformsSchemaTableTarget
      - `database` integer
      - `name` string, required
      - `schema` string, nullable
      - `type` 'table', required
    - MetabaseTransformsSchemaTableIncrementalTarget
      - `database` integer
      - `name` string, required
      - `schema` string, nullable
      - `target-incremental-strategy` MetabaseTransformsSchemaTargetIncrementalStrategy, required
        - `type` 'append', required
      - `type` 'table-incremental', required

## Response `2XX`

Successful response

- object
  - `collection_id` integer, nullable, required
  - `created_at` unknown, required
  - `creator` object, required
    - `common_name` string, nullable
    - `date_joined` unknown
    - `email` string, required
    - `first_name` string, nullable, required
    - `id` integer, required
    - `is_data_analyst` boolean
    - `is_qbnewb` boolean
    - `is_superuser` boolean
    - `last_login` unknown
    - `last_name` string, nullable, required
    - `tenant_id` unknown
  - `creator_id` integer, required
  - `description` string, nullable, required
  - `entity_id` string, nullable, required
  - `id` integer, required
  - `last_checkpoint_value` string, nullable
  - `last_run` object, nullable
    - `checkpoint_filter_field_id` integer, nullable
    - `checkpoint_hi_value` string, nullable
    - `checkpoint_lo_value` string, nullable
    - `end_time` unknown
    - `id` integer, required
    - `is_active` boolean, nullable, required
    - `message` string, nullable, required
    - `metered_as` string, nullable
    - `run_method` string, required
    - `start_time` unknown, required
    - `status` 'started' | 'succeeded' | 'failed' | 'timeout' | 'canceled' | 'canceling', required
    - `transform_entity_id` string, nullable
    - `transform_id` integer, required
    - `transform_name` string, nullable
    - `user_id` integer, nullable, required
  - `name` string, required
  - `owner` object, nullable
    - `common_name` string, nullable
    - `email` string, required
    - `first_name` string, nullable
    - `id` integer
    - `last_name` string, nullable
  - `owner_email` string, nullable
  - `owner_user_id` integer, nullable
  - `run_trigger` string, nullable
  - `source` unknown, required
  - `source_database_id` integer, nullable
  - `source_readable` boolean, nullable
  - `source_type` string, required
  - `table` object, nullable
  - `tag_ids` integer[]
  - `target` unknown, required
  - `target_db_id` integer, nullable
  - `target_table_id` integer, nullable
  - `updated_at` unknown, required

## Other responses

- `4XX` — Client error response
- `5XX` — Server error response

---

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