---
title: "Update model"
method: PUT
path: "/storage/models/{uuid}"
tags: ["Storage - Models"]
---

# Update model

`PUT /storage/models/{uuid}`

Update a model by UUID

## Path parameters

- `uuid` string, uuid, required — Model identifier.

## Request body

- object — Request body schema.
  - `name` string — Model name.
  - `description` string, nullable — Model description.
  - `position` object — Model position in the canvas.
    - `x` number, required — Horizontal position.
    - `y` number, required — Vertical position.
  - `config` object — Model configuration.
  - `schedule` union — Model schedule configuration.
    - object
      - `type` 'dbt', required
      - `jobId` string, required
    - object
      - `type` 'cron', required
      - `cron` string, required
  - `unification` union — Model unification configuration.
    - object
      - `source` 'integration', required
    - object
      - `source` 'custom', required
      - `type` 'account' | 'contact' | 'accountEvent' | 'contactEvent', required
      - `uniqueColumns` object[], required
        - `slug` string, required
        - `reference` string, required
      - `selectedColumnSlugs` string[]
      - `timeColumnSlug` string
      - `parent` union
        - object
          - `kind` 'model', required
          - `columnSlug` string, required
          - `parentModelUuid` string, required
        - object
          - `kind` 'reference', required
          - `columnSlug` string, required
          - `reference` string, required
      - `filter` object
        - `conjonction` 'or' | 'and', required
        - `groups` object[], required
          - `conjonction` 'or' | 'and', required
          - `conditions` union[], required
            - union
              - …
  - `folderUuid` string, uuid, nullable — Folder identifier. Only compatible with nativeIntegration define extractors.

## Response `200`

Successful response

- object
  - `model` union, required
    - object — Updated model details.
      - `uuid` string, required
      - `workspaceUuid` string, required
      - `slug` string, required
      - `name` string, required
      - `description` string, nullable, required
      - `datasetUuid` string, required
      - `extractorSlug` string, required
      - `position` object, required
        - `x` number, required
        - `y` number, required
      - `config` object, required
      - `schedule` union, required
        - object
          - `type` 'dbt', required
          - `jobId` string, required
        - object
          - `type` 'cron', required
          - `cron` string, required
          - `temporalScheduleWorkflowId` string, required
      - `meta` object, nullable, required
      - `columns` object[], required
        - `slug` string, required
        - `type` 'string' | 'number' | 'object' | 'array' | 'date' | 'boolean' | 'any' | 'vector', required
        - `properties` string[]
        - `label` string, required
        - `description` string
        - `kind` 'original', required
        - `originalSlug` string, required
      - `additionalColumns` union[], required
        - union
          - object
            - `slug` string, required
            - `type` 'string' | 'number' | 'object' | 'array' | 'date' | 'boolean' | 'any' | 'vector', required
            - `properties` string[]
            - `label` string, required
            - `description` string
            - `kind` 'custom', required
          - object
            - `slug` string, required
            - `type` 'string' | 'number' | 'object' | 'array' | 'date' | 'boolean' | 'any' | 'vector', required
            - `properties` string[]
            - `label` string, required
            - `description` string
            - `kind` 'computed', required
            - `expression` union, required
              - …
            - `columnsUsed` string[]
          - object
            - `slug` string, required
            - `type` 'string' | 'number' | 'object' | 'array' | 'date' | 'boolean' | 'any' | 'vector', required
            - `properties` string[]
            - `label` string, required
            - `description` string
            - `kind` 'metric', required
            - `relationshipUuid` string, required
            - `aggregation` object, required
              - …
            - `filter` object
              - …
          - object
            - `slug` string, required
            - `type` 'string' | 'number' | 'object' | 'array' | 'date' | 'boolean' | 'any' | 'vector', required
            - `properties` string[]
            - `label` string, required
            - `description` string
            - `kind` 'lookup', required
            - `join` object, required
              - …
            - `extractColumnSlug` string, required
            - `filter` object
              - …
      - `idColumnSlug` string, required
      - `unification` union, required
        - object
          - `source` 'integration', required
        - object
          - `source` 'custom', required
          - `type` 'account' | 'contact' | 'accountEvent' | 'contactEvent', required
          - `uniqueColumns` object[], required
            - `slug` string, required
            - `reference` string, required
          - `selectedColumnSlugs` string[]
          - `timeColumnSlug` string
          - `parent` union
            - object
              - …
            - object
              - …
          - `filter` object
            - `conjonction` 'or' | 'and', required
            - `groups` object[], required
              - …
      - `titleColumnSlug` string, required
      - `timeColumnSlug` string, nullable, required
      - `folderUuid` string, nullable, required
      - `playsCount` number, required
      - `segmentsCount` number, required
      - `isPaused` boolean, required
      - `lastEmittedAt` string, nullable, required
      - `createdAt` string, required
      - `updatedAt` string, required
      - `deletedAt` string, nullable, required
      - `lastRun` object, nullable, required
        - `uuid` string, required
        - `status` 'pending' | 'running' | 'cancelling' | 'cancelled' | 'error' | 'success', required
        - `errorMessage` string, nullable, required
        - `createdAt` string, required
        - `finishedAt` string, nullable, required
      - `kind` 'connector', required
      - `connectorUuid` string, required
    - object — Updated model details.
      - `uuid` string, required
      - `workspaceUuid` string, required
      - `slug` string, required
      - `name` string, required
      - `description` string, nullable, required
      - `datasetUuid` string, required
      - `extractorSlug` string, required
      - `position` object, required
        - `x` number, required
        - `y` number, required
      - `config` object, required
      - `schedule` union, required
        - object
          - `type` 'dbt', required
          - `jobId` string, required
        - object
          - `type` 'cron', required
          - `cron` string, required
          - `temporalScheduleWorkflowId` string, required
      - `meta` object, nullable, required
      - `columns` object[], required
        - `slug` string, required
        - `type` 'string' | 'number' | 'object' | 'array' | 'date' | 'boolean' | 'any' | 'vector', required
        - `properties` string[]
        - `label` string, required
        - `description` string
        - `kind` 'original', required
        - `originalSlug` string, required
      - `additionalColumns` union[], required
        - union
          - object
            - `slug` string, required
            - `type` 'string' | 'number' | 'object' | 'array' | 'date' | 'boolean' | 'any' | 'vector', required
            - `properties` string[]
            - `label` string, required
            - `description` string
            - `kind` 'custom', required
          - object
            - `slug` string, required
            - `type` 'string' | 'number' | 'object' | 'array' | 'date' | 'boolean' | 'any' | 'vector', required
            - `properties` string[]
            - `label` string, required
            - `description` string
            - `kind` 'computed', required
            - `expression` union, required
              - …
            - `columnsUsed` string[]
          - object
            - `slug` string, required
            - `type` 'string' | 'number' | 'object' | 'array' | 'date' | 'boolean' | 'any' | 'vector', required
            - `properties` string[]
            - `label` string, required
            - `description` string
            - `kind` 'metric', required
            - `relationshipUuid` string, required
            - `aggregation` object, required
              - …
            - `filter` object
              - …
          - object
            - `slug` string, required
            - `type` 'string' | 'number' | 'object' | 'array' | 'date' | 'boolean' | 'any' | 'vector', required
            - `properties` string[]
            - `label` string, required
            - `description` string
            - `kind` 'lookup', required
            - `join` object, required
              - …
            - `extractColumnSlug` string, required
            - `filter` object
              - …
      - `idColumnSlug` string, required
      - `unification` union, required
        - object
          - `source` 'integration', required
        - object
          - `source` 'custom', required
          - `type` 'account' | 'contact' | 'accountEvent' | 'contactEvent', required
          - `uniqueColumns` object[], required
            - `slug` string, required
            - `reference` string, required
          - `selectedColumnSlugs` string[]
          - `timeColumnSlug` string
          - `parent` union
            - object
              - …
            - object
              - …
          - `filter` object
            - `conjonction` 'or' | 'and', required
            - `groups` object[], required
              - …
      - `titleColumnSlug` string, required
      - `timeColumnSlug` string, nullable, required
      - `folderUuid` string, nullable, required
      - `playsCount` number, required
      - `segmentsCount` number, required
      - `isPaused` boolean, required
      - `lastEmittedAt` string, nullable, required
      - `createdAt` string, required
      - `updatedAt` string, required
      - `deletedAt` string, nullable, required
      - `lastRun` object, nullable, required
        - `uuid` string, required
        - `status` 'pending' | 'running' | 'cancelling' | 'cancelled' | 'error' | 'success', required
        - `errorMessage` string, nullable, required
        - `createdAt` string, required
        - `finishedAt` string, nullable, required
      - `kind` 'native', required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found
- `500` — Internal server error

---

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