---
title: "Patch a Plugin"
method: PATCH
path: "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}"
tags: ["Plugins"]
---

# Patch a Plugin

`PATCH /api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}`
- Auth: none declared

## Path parameters

- `workspaceId` string, required
- `objectId` string, required

## Query parameters

- `filter` string
- `include` string[]

## Request body

- JsonApiDashboardPluginPatchDocument
  - `data` JsonApiDashboardPluginPatch, required: JSON:API representation of patching dashboardPlugin entity.
    - `attributes` object
      - `areRelationsValid` boolean
      - `content` object: Free-form JSON content. Maximum supported length is 250000 characters.
      - `description` string
      - `tags` string[]
      - `title` string
    - `id` string, required: API identifier of an object
    - `type` 'dashboardPlugin', required: Object type

## Response `200`

Request successfully processed

- JsonApiDashboardPluginOutDocument
  - `data` JsonApiDashboardPluginOut, required: JSON:API representation of dashboardPlugin entity.
    - `attributes` object
      - `areRelationsValid` boolean
      - `content` object: Free-form JSON content. Maximum supported length is 250000 characters.
      - `createdAt` string, date-time, nullable: Time of the entity creation.
      - `description` string
      - `modifiedAt` string, date-time, nullable: Time of the last entity modification.
      - `tags` string[]
      - `title` string
    - `id` string, required: API identifier of an object
    - `meta` object
      - `origin` object
        - `originId` string, required: defines id of the workspace where the entity comes from
        - `originType` 'NATIVE' | 'PARENT', required: defines type of the origin of the entity
    - `relationships` object
      - `createdBy` object
        - `data` JsonApiUserIdentifierToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'userIdentifier', required
      - `modifiedBy` object
        - `data` JsonApiUserIdentifierToOneLinkage, required: The \"type\" and \"id\" to non-empty members.
          - `id` string, required
          - `type` 'userIdentifier', required
    - `type` 'dashboardPlugin', required: Object type
  - `included` JsonApiUserIdentifierOutWithLinks[]: Included resources
    - `attributes` object
      - `email` string
      - `firstname` string
      - `lastname` string
    - `id` string, required: API identifier of an object
    - `type` 'userIdentifier', required: Object type
    - `links` ObjectLinks
      - `self` string, uri, required: A string containing the link's URL.
  - `links` ObjectLinks
    - `self` string, uri, required: A string containing the link's URL.
  - `meta` object
    - `restricted` RestrictedObject[]: References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
      - `id` string, required: Object identifier, unique within one workspace hierarchy.
      - `type` 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'computedAttribute' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'visualizationObject', required: JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`.

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)