POST /rest/api/2/uiModifications

Creates a UI modification. UI modification can only be created by Forge apps.

Each app can define up to 3000 UI modifications. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications.

Context types:

Jira contexts: For Jira view types, use projectId and issueTypeId. One field can act as a wildcard. Supported Jira views:
- GIC - Jira global issue create
- IssueView - Jira issue view
- IssueTransition - Jira issue transition
Jira Service Management contexts: For Jira Service Management view types, use portalId and requestTypeId. Wildcards are not supported. Supported JSM views:
- JSMRequestCreate - Jira Service Management request create portal view

Permissions required:

None if the UI modification is created without contexts.
Browse projects project permission for one or more projects, if the UI modification is created with contexts.

The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.

Servers

https://your-domain.atlassian.net

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
`data`	String	No	The data of the UI modification. The maximum size of the data is 50000 characters.
`name`	String	Yes	The name of the UI modification. The maximum length is 255 characters.
`description`	String	No	The description of the UI modification. The maximum length is 255 characters.
`contexts[]`	Array	No	List of contexts of the UI modification. The maximum number of contexts is 1000.
`contexts[].id`	String	No	The ID of the UI modification context.
`contexts[].projectId`	String	No	The project ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all projects. Each UI modification context can have a maximum of one wildcard.
`contexts[].viewType`	String	No	The view type of the context. Supported values: `GIC` - Jira global issue create `IssueView` - Jira issue view `IssueTransition` - Jira issue transition `JSMRequestCreate` - Jira Service Management request create portal view For Jira view types (`GIC`, `IssueView`, `IssueTransition`), null is treated as a wildcard, meaning the UI modification will be applied to all view types. Each Jira context can have a maximum of one wildcard. Wildcards are not applicable for JSM contexts. Valid values: `"GIC"` `"IssueView"` `"IssueTransition"` `"JSMRequestCreate"`
`contexts[].requestTypeId`	String	No	The request type ID of the context. Only required for Jira Service Management request create portal view (`JSMRequestCreate`).
`contexts[].isAvailable`	Boolean	No	Whether a context is available. For example, when a project is deleted the context becomes unavailable.
`contexts[].portalId`	String	No	The portal ID of the context. Only required for Jira Service Management request create portal view (`JSMRequestCreate`).
`contexts[].issueTypeId`	String	No	The issue type ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all issue types. Each UI modification context can have a maximum of one wildcard.

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.