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

Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string ("") the component lead is removed.

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project containing the component or Administer Jira global permission.

Servers

https://your-domain.atlassian.net

Path parameters

Name	Type	Required	Description
`id`	String	Yes	The ID of the component.

Request headers

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

Request body fields

Name	Type	Required	Description
`projectId`	Integer	No	The ID of the project the component is assigned to.
`leadAccountId`	String	No	The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
`description`	String	No	The description for the component. Optional when creating or updating a component.
`isAssigneeTypeValid`	Boolean	No	Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned.
`metadata`	Object	No	Compass component's metadata. Can't be updated. Not required for creating a Project Component.
`ari`	String	No	Compass component's ID. Can't be updated. Not required for creating a Project Component.
`assigneeType`	String	No	The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values: `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in. `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component. `UNASSIGNED` an assignee is not set for issues created with this component. `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in. Default value: `PROJECT_DEFAULT`. Optional when creating or updating a component. Possible values: `"COMPONENT_LEAD"` `"UNASSIGNED"` `"PROJECT_DEFAULT"` `"PROJECT_LEAD"`
`realAssigneeType`	String	No	The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values: `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in. `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in. `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues. `PROJECT_DEFAULT` when none of the preceding cases are true. Possible values: `"COMPONENT_LEAD"` `"UNASSIGNED"` `"PROJECT_DEFAULT"` `"PROJECT_LEAD"`
`id`	String	No	The unique identifier for the component.
`name`	String	No	The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.
`self`	String	No	The URL of the component.
`leadUserName`	String	No	This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
`project`	String	No	The key of the project the component is assigned to. Required when creating a component. Can't be updated.

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.