---
title: "Update a Workload Profile"
method: PUT
path: "/orgs/{orgId}/workload-profiles/{profileQid}"
tags: ["public", "WorkloadProfile"]
---

# Update a Workload Profile

`PUT /orgs/{orgId}/workload-profiles/{profileQid}`

## Path parameters

- `orgId` string, required
- `profileQid` string, required

## Request body

- WorkloadProfileUpdateRequest — The proposed properties to update a workload profile.
  - `description` string — Describes the workload profile
  - `deprecation_message` string — A not-empty string indicates that the workload profile is deprecated.
  - `spec_definition` WorkloadProfileSpecDefinition, required — Workload spec definition
    - `properties` WorkloadProfileSpecDefinitionProperties — Workload spec definition
    - `runtime_properties` WorkloadProfileSpecDefinitionRuntimeProperty[]
      - `type` 'feature' | 'collection', required
      - `feature_name` string
      - `title` string
      - `version` string
      - `ui_hints` WorkloadProfileSpecDefinitionPropertyUIHints
        - `order` integer
        - `hidden` boolean
  - `version` string — Version identifier. The version must be unique, but the API doesn't not enforce any ordering. Currently workloads will always use the latest update. If no identifier is provided, the each update will generate a random version identifier.
  - `workload_profile_chart` WorkloadProfileChartReference, required — References a workload profile chart.
    - `id` string, required — Workload Profile Chart ID
    - `version` string, required — Version

## Response `200`

The resulting WorkloadProfile.

- WorkloadProfileResponse — Workload Profiles provide the baseline configuration for Workloads in Applications in Humanitec. Developers can configure various features of a workload profile to suit their needs. Examples of features might be `schedules` used in Kubernetes CronJobs or `ingress` which might be used to expose Pods controlled by a Kubernetes Deployment. Workloads in Humanitec are implemented as Helm Charts which must implement a specific schema.
  - `created_at` string, date-time, required — Creation date
  - `created_by` string, required — User created the profile
  - `description` string, required — Describes the workload profile
  - `deprecation_message` string — A not-empty string indicates that the workload profile is deprecated.
  - `id` string, required — Workload Profile ID
  - `org_id` string, required — Organization ID
  - `spec_definition` WorkloadProfileSpecDefinition, required — Workload spec definition
    - `properties` WorkloadProfileSpecDefinitionProperties — Workload spec definition
    - `runtime_properties` WorkloadProfileSpecDefinitionRuntimeProperty[]
      - `type` 'feature' | 'collection', required
      - `feature_name` string
      - `title` string
      - `version` string
      - `ui_hints` WorkloadProfileSpecDefinitionPropertyUIHints
        - `order` integer
        - `hidden` boolean
  - `spec_schema` unknown, required
  - `updated_at` string, date-time, required — Timestamp when the entity was last updated.
  - `updated_by` string, required — User who last updated the entity.
  - `version` string, required — Version identifier.
  - `workload_profile_chart` WorkloadProfileChartReference, required — References a workload profile chart.
    - `id` string, required — Workload Profile Chart ID
    - `version` string, required — Version

## Other responses

- `400` — The request was invalid. More detail can be found in the error body.
- `404` — Either the resource or a related resource could not be found. More detail can be found in the error body.
- `409` — The request itself is valid however it could not be applied based on the current state of the resource. More detail can be found in the error body.

---

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