---
title: "Update Flavor"
method: PUT
path: "/api/v1/flavors/{flavor_id}"
tags: ["flavors"]
---

# Update Flavor

`PUT /api/v1/flavors/{flavor_id}`

## Request

- The document declares no server URL.
- Auth: OAuth 2
  - Password
  - Token URL: `/api/v1/login`
- TypeScript: <https://skmtc.dev/zenml-io/apis/zenml/docs/api/v1/flavors/:flavor_id/put.ts> (a function with typed inputs; its response is checked against the schema)

Updates a flavor.

# noqa: DAR401

Args:
    flavor_id: ID of the flavor to update.
    flavor_update: Flavor update.

Returns:
    The updated flavor.

## Path parameters

- `flavor_id` string, uuid, required

## Request body

- FlavorUpdate: Update model for flavors.
  - `name` string, nullable
  - `type` 'alerter' | 'annotator' | 'artifact_store' | 'container_registry' | 'data_validator' | 'experiment_tracker' | 'feature_store' | 'image_builder' | 'model_deployer' | 'orchestrator' | 'step_operator' | 'model_registry': All possible types a `StackComponent` can have.
  - `config_schema` object, nullable
  - `connector_type` string, nullable
  - `connector_resource_type` string, nullable
  - `connector_resource_id_attr` string, nullable
  - `source` string, nullable
  - `integration` string, nullable
  - `logo_url` string, nullable
  - `docs_url` string, nullable
  - `sdk_docs_url` string, nullable
  - `is_custom` boolean, nullable
  - `workspace` string, uuid, nullable

## Response `200`

Successful Response

- FlavorResponse: Response model for flavors.
  - `body` FlavorResponseBody: Response body for flavor.
    - `created` string, date-time, required
    - `updated` string, date-time, required
    - `user` UserResponse: Response model for user and service accounts. This returns the activation_token that is required for the user-invitation-flow of the frontend. The email is returned optionally as well for use by the analytics on the client-side.
      - `body` UserResponseBody: Response body for users.
        - `created` string, date-time, required
        - `updated` string, date-time, required
        - `active` boolean
        - `activation_token` string, nullable
        - `full_name` string
        - `email_opted_in` boolean, nullable: `null` if not answered, `true` if agreed, `false` if skipped.
        - `is_service_account` boolean, required
        - `is_admin` boolean, required
      - `metadata` UserResponseMetadata: Response metadata for users.
        - `email` string, nullable
        - `external_user_id` string, uuid, nullable
        - `user_metadata` object
      - `resources` UserResponseResources: Class for all resource models associated with the user entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `type` 'alerter' | 'annotator' | 'artifact_store' | 'container_registry' | 'data_validator' | 'experiment_tracker' | 'feature_store' | 'image_builder' | 'model_deployer' | 'orchestrator' | 'step_operator' | 'model_registry', required: All possible types a `StackComponent` can have.
    - `integration` string, nullable, required
    - `logo_url` string, nullable
  - `metadata` FlavorResponseMetadata: Response metadata for flavors.
    - `workspace` WorkspaceResponse, required: Response model for workspaces.
      - `body` WorkspaceResponseBody: Response body for workspaces.
        - `created` string, date-time, required
        - `updated` string, date-time, required
      - `metadata` WorkspaceResponseMetadata: Response metadata for workspaces.
        - `description` string
      - `resources` WorkspaceResponseResources: Class for all resource models associated with the workspace entity.
      - `id` string, uuid, required
      - `permission_denied` boolean
      - `name` string, required
    - `config_schema` object, required
    - `connector_type` string, nullable
    - `connector_resource_type` string, nullable
    - `connector_resource_id_attr` string, nullable
    - `source` string, required
    - `docs_url` string, nullable
    - `sdk_docs_url` string, nullable
    - `is_custom` boolean
  - `resources` FlavorResponseResources: Class for all resource models associated with the flavor entity.
  - `id` string, uuid, required
  - `permission_denied` boolean
  - `name` string, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `409`: Conflict
- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/zenml-io/apis/zenml.md) - [All operations](https://skmtc.dev/zenml-io/apis/zenml/llms.txt) - [OpenAPI document](https://skmtc.dev/zenml-io/apis/zenml/revisions/abe684261209?raw)