Agents2

Announcement banner2

App data policies2

App migration3

App properties8

Application roles2

Audit records1

Avatars7

Classification levels1

Dashboards17

Dynamic modules3

Field schemes15

Filter sharing6

Filters13

Group and user picker1

Groups8

Issue attachments8

Issue bulk operations9

Issue comment properties4

Issue comments6

Issue custom field associations2

Issue custom field configuration (apps)3

Issue custom field contexts15

Issue custom field options7

Issue custom field options (apps)8

Issue custom field values (apps)2

Issue field configurations15

Issue fields11

Issue link types5

Issue links3

Issue navigator settings2

Issue notification schemes8

Issue panels2

Issue priorities8

Issue properties8

Issue redaction2

Issue remote links6

Issue resolutions8

Issue search7

Issue security level2

Issue security schemes16

Issue type properties4

Issue type schemes10

Issue type screen schemes11

Issue types8

Issue votes3

Issue watchers4

Issue worklog properties4

Issue worklogs10

Issues24

Jira expressions3

Jira settings4

JQL7

JQL functions (apps)3

Labels1

License metrics3

Migration of Connect modules to Forge2

Myself6

Permission schemes9

Permissions4

Plans7

Policies7

Priority schemes8

Project avatars4

Project categories5

Project classification levels4

Project components8

Project email2

Project features2

Project key and name validation3

Project permission schemes4

Project properties4

Project role actors6

Project roles9

Project templates5

Project types4

Project versions15

Projects13

Screen schemes4

Screen tab fields4

Screen tabs6

Screens7

Server info1

Service Registry1

Status9

Tasks2

Teams in plan9

Time tracking5

UI modifications (apps)4

User properties4

User search8

Users13

Webhooks5

Workflow scheme drafts14

Workflow scheme project associations2

Workflow schemes19

Workflow status categories2

Workflow statuses2

Workflow transition rules3

Workflows17

post/rest/internal/api/latest/worklog/bulkGet worklogs by issue id and worklog id

Project components

Update component

Changed on Feb 8, 2026

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.

put/rest/api/3/component/{id}

Request

Base URL
https://your-domain.atlassian.net
URL
https://your-domain.atlassian.net/rest/api/3/component/{id}
Auth
- HTTP basic
- or OAuth 2
  Authorization code: https://auth.atlassian.com/authorize
  Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-project
- or none

Path parameters

idstring required

The ID of the component.

Request body

aristring

Compass component's ID. Can't be updated. Not required for creating a Project Component.

assigneeType'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED'

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.

descriptionstring

The description for the component. Optional when creating or updating a component.

idstring

The unique identifier for the component.

isAssigneeTypeValidboolean

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.

leadAccountIdstring

The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

leadUserNamestring

This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.

metadataobject

Compass component's metadata. Can't be updated. Not required for creating a Project Component.

namestring

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.

projectstring

The key of the project the component is assigned to. Required when creating a component. Can't be updated.

projectIdinteger

The ID of the project the component is assigned to.

realAssigneeType'PROJECT_DEFAULT' | 'COMPONENT_LEAD' | 'PROJECT_LEAD' | 'UNASSIGNED'

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 assigneeType 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.

selfstring uri

The URL of the component.

Response

Returned if the request is successful.