Validate create workflows

POST

/rest/api/3/workflows/create/validation

Validate the payload for bulk create workflows.

Permissions required:

Administer Jira project permission to create all, including global-scoped, workflows

Administer projects project permissions to create project-scoped workflows

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/rest/api/3/workflows/create/validation' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payload": {
        "scope": {
            "type": "GLOBAL"
        },
        "statuses": [
            {
                "description": "",
                "name": "To Do",
                "statusCategory": "TODO",
                "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
            },
            {
                "description": "",
                "name": "In Progress",
                "statusCategory": "IN_PROGRESS",
                "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
            },
            {
                "description": "",
                "name": "Done",
                "statusCategory": "DONE",
                "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
            }
        ],
        "workflows": [
            {
                "description": "",
                "name": "Software workflow 1",
                "startPointLayout": {
                    "x": -100.00030899047852,
                    "y": -153.00020599365234
                },
                "statuses": [
                    {
                        "layout": {
                            "x": 114.99993896484375,
                            "y": -16
                        },
                        "properties": {},
                        "statusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0"
                    },
                    {
                        "layout": {
                            "x": 317.0000915527344,
                            "y": -16
                        },
                        "properties": {},
                        "statusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8"
                    },
                    {
                        "layout": {
                            "x": 508.000244140625,
                            "y": -16
                        },
                        "properties": {},
                        "statusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849"
                    }
                ],
                "transitions": [
                    {
                        "actions": [],
                        "description": "",
                        "id": "1",
                        "links": [],
                        "name": "Create",
                        "properties": {},
                        "toStatusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0",
                        "triggers": [],
                        "type": "INITIAL",
                        "validators": []
                    },
                    {
                        "actions": [],
                        "description": "",
                        "id": "11",
                        "links": [],
                        "name": "To Do",
                        "properties": {},
                        "toStatusReference": "f0b24de5-25e7-4fab-ab94-63d81db6c0c0",
                        "triggers": [],
                        "type": "GLOBAL",
                        "validators": []
                    },
                    {
                        "actions": [],
                        "description": "",
                        "id": "21",
                        "links": [],
                        "name": "In Progress",
                        "properties": {},
                        "toStatusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8",
                        "triggers": [],
                        "type": "GLOBAL",
                        "validators": []
                    },
                    {
                        "actions": [],
                        "description": "Move a work item from in progress to done",
                        "id": "31",
                        "links": [
                            {
                                "fromPort": 0,
                                "fromStatusReference": "c7a35bf0-c127-4aa6-869f-4033730c61d8",
                                "toPort": 1
                            }
                        ],
                        "name": "Done",
                        "properties": {},
                        "toStatusReference": "6b3fc04d-3316-46c5-a257-65751aeb8849",
                        "triggers": [],
                        "type": "DIRECTED",
                        "validators": []
                    }
                ]
            }
        ]
    },
    "validationOptions": {
        "levels": [
            "ERROR",
            "WARNING"
        ]
    }
}'

Response Example

{"errors":[{"code":"NON_UNIQUE_STATUS_NAME","elementReference":{"statusReference":"1f0443ff-47e4-4306-9c26-0af696059a43"},"level":"ERROR","message":"You must use a unique status name.","type":"STATUS"}]}

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

Returned if the request is successful.

Body

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-07-16 07:18:01

Bulk create workflows

Get the user's default workflow editor