PUT /rest/api/2/dashboard/{id}

Updates a dashboard, replacing all the dashboard details with those provided.

Permissions required: None

The dashboard to be updated must be owned by the user.

Servers

https://your-domain.atlassian.net

Path parameters

Name	Type	Required	Description
`id`	String	Yes	The ID of the dashboard to update.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name Type Required Description

Name	Type	Required	Description
`extendAdminPermissions`	Boolean	No	Whether admin level permissions are used. It should only be true if the user has Administer Jira global permission Default value: false

extendAdminPermissions

Boolean

Whether admin level permissions are used. It should only be true if the user has Administer Jira global permission

Default value: false

Request body fields

Name	Type	Required	Description
`editPermissions[]`	Array	Yes	The edit permissions for the dashboard.
`editPermissions[].id`	Integer	No	The unique identifier of the share permission.
`editPermissions[].type`	String	Yes	The type of share permission: `user` Shared with a user. `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`. `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request. Possible values: `"global"` `"group"` `"project"` `"project-unknown"` `"projectRole"` `"loggedin"` `"user"` `"authenticated"`
`name`	String	Yes	The name of the dashboard.
`description`	String	No	The description of the dashboard.
`sharePermissions[]`	Array	Yes	The share permissions for the dashboard.
`sharePermissions[].id`	Integer	No	The unique identifier of the share permission.
`sharePermissions[].type`	String	Yes	The type of share permission: `user` Shared with a user. `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`. `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request. Possible values: `"global"` `"group"` `"project"` `"project-unknown"` `"projectRole"` `"loggedin"` `"user"` `"authenticated"`

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.