---
title: "Update parameter"
method: PATCH
path: "/workspaces/{workspace_id}/parameters/{parameter_id}"
tags: ["Parameters"]
---

# Update parameter

`PATCH /workspaces/{workspace_id}/parameters/{parameter_id}`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/workspaces/{workspace_id}/parameters/{parameter_id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

Update a parameter

## Path parameters

- `workspace_id` integer, required: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.
- `parameter_id` integer, required

## Request body

- ParameterUpdateSchema: Update a parameter
  - `name` string, nullable: New parameter name
  - `value` union: New parameter value (NUMERIC=number, TEXT/DATE=string)
    - string
    - number
    - integer
  - `param_type` string, nullable: New parameter type
  - `description` string, nullable: New parameter description
  - `group_id` integer, nullable: New group ID (null to ungroup)

## Response `200`

Update ParameterResponse

- ParameterResponse
  - `id` integer, required
  - `name` string, required
  - `value` union, required
    - string
    - number
    - integer
  - `param_type` string, required
  - `description` string, nullable
  - `scope` string, required
  - `group_id` integer, nullable
  - `group_name` string, nullable
  - `pipeline_count` integer, required
  - `stale_pipelines` integer[]
  - `created_by` integer, required
  - `created_at` string, required
  - `updated_by` integer, nullable
  - `updated_at` string, required

## Other responses

- `400`: Bad Request
- `401`: Authorization error
- `403`: Request forbidden -- authorization will not help

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/4b2c943a00dc?raw)