---
title: "Update a plugin"
method: PATCH
path: "/v2/plugins/{pluginId}"
tags: ["plugins"]
---

# Update a plugin

`PATCH /v2/plugins/{pluginId}`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/plugins/{pluginId}`
- Auth: HTTP bearer

Update metadata fields on an existing plugin. Only fields included in the request are changed. The `url` field cannot be updated by this endpoint.

### Usage notes
- Retrieve the **pluginId** by calling the [/v2/plugins](/reference/list-custom-plugins) endpoint.
- To perform this operation, you must use API credentials owned by a user assigned the Admin account type or an account type with the **Manage plugins** permission enabled.

## Path parameters

- `pluginId` string, required

## Request body

- object
  - `name` string: Display name of the plugin.
  - `description` string, nullable: Description of the plugin.
  - `devUrl` string, nullable: Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode.

## Response `200`

The response body.

- PluginsUpdateCustomPluginResponse200
  - `pluginId` string, required: Unique identifier (UUID) of the plugin.
  - `name` string, required: Display name of the plugin.
  - `description` string, nullable, required: Description of the plugin.
  - `url` string, required: Production URL where the plugin is hosted. Sigma loads the plugin from this URL when it is added to a workbook. An empty string indicates that no production URL has been set for the plugin yet.
  - `devUrl` string, nullable, required: Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode.
  - `type` 'element', required

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)