POST /rest/api/2/issue

Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set.

The content of the issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the Get create issue metadata. These are the same fields that appear on the issue's create screen.

Creating a subtask differs from creating an issue as follows:

Permissions required: Browse projects and Create issues project permissions for the project in which the issue or subtask is created.

Servers

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
updateHistory Boolean No

Whether the project in which the issue is created is added to the user's Recently viewed project list, as shown under Projects in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen.

Default value: false

Request body fields

Name Type Required Description
properties[] Array No

Details of issue properties to be add or update.

properties[].key String No

The key of the property. Required on create and update.

properties[].value No

The value of the property. Required on create and update.

fields Object No

List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use update. Fields included in here cannot be included in update.

update Object No

A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in fields.

update.name Object No

Details of an operation to perform on a field.

update.name.edit No

The value to edit in the field.

update.name.remove No

The value to removed from the field.

update.name.copy No

The field value to copy from another issue.

update.name.set No

The value to set in the field.

update.name.add No

The value to add to the field.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.