Skip to main content

Remove a Test Case Type (API)

Remove an unused test case type from a Jira space with the Vansah API, including identifier lookup, request examples, permissions, and errors.

Remove a test case type that your team no longer needs in a Jira space. The API marks the type as deleted and removes it from the active type list. It does not delete test cases or automatically assign them a replacement type.

Before you begin

  • Have a Vansah API token and your workspace’s Vansah API URL.

  • The token account must be able to access the Jira space and have permission to delete work items (DELETE_ISSUES) or administer the space (ADMINISTER_PROJECTS).

  • Review any cases using the type. If you want them to use a different type, update them before removing the old one.

The examples use Bash and cURL. Set VANSAH_URL to your Vansah base URL without a trailing slash and VANSAH_TOKEN to your API token. Replace DEMO and the example identifier with values from your own Jira space.

Endpoint and headers

DELETE /api/v2/category/caseType/{caseTypeIdentifier}

Header

Value

Authorization

Your Vansah API token, without a Bearer prefix.

Content-Type

application/json

Accept

application/json

1. Find the type identifier

List the active test case types in the Jira space:

curl --request GET \
--url "$VANSAH_URL/api/v2/category/caseTypes?projectKey=DEMO&startAt=0&limit=100" \
--header "Authorization: $VANSAH_TOKEN" \
--header "Accept: application/json"

Find the type by its name in the response’s data array and copy its identifier. Use that identifier in the DELETE URL, rather than the type name or a test case key.

The list is sorted by name and excludes deleted types. It defaults to startAt=0 and limit=100. Increase startAt by the page size until you reach pagination.total. Use whole numbers, with startAt zero or greater and a positive limit. See List Test Case Types for response examples.

2. Prepare the removal request

Field

How to use it

caseTypeIdentifier in the path

Required. The UUID of an active type in the selected Jira space, returned by the list endpoint.

project.key in the JSON body

The Jira space key. Include it as shown below to identify the space. The space can also be supplied through the projectKey query parameter. Use one space per request.

project.key and projectKey refer to the Jira space key. Their API names remain unchanged. No type name is needed in the DELETE request.

{
"project": {
"key": "DEMO"
}
}

3. Remove the type

Send the DELETE request with the Jira space details in the JSON body:

curl --request DELETE \
--url "$VANSAH_URL/api/v2/category/caseType/c7e055f6-f32f-11ef-baf9-5a0ced9d1480" \
--header "Authorization: $VANSAH_TOKEN" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data '{"project":{"key":"DEMO"}}'

Example successful response:

{
"success": true,
"message": "Removed successfully",
"data": {
"identifier": "c7e055f6-f32f-11ef-baf9-5a0ced9d1480",
"name": "Integration1"
}
}

success: true confirms the removal. data.identifier and data.name identify the type that was removed.

List the types again to confirm that the removed type no longer appears. Repeating the DELETE request returns an invalid-identifier error because the type is no longer active.

If you need the type again

This API does not provide a restore endpoint for test case types. Creating a type with the same name creates a new type with a different identifier; it does not restore the original type or reassign existing cases.

Troubleshooting

Message or issue

How to resolve it

Invalid caseType identifier(...)

Check that the identifier is correct, active, and belongs to the selected Jira space. A previously removed type returns the same error.

Missing or invalid space information

Include project.key in the JSON body or projectKey in the URL. Confirm that the token account can access that Jira space.

Authentication or permission error

Check the Vansah API URL, token, and the token account’s permission to delete work items or administer the space.

Something went wrong while Removing CaseType

List the types to check whether the removal took effect before retrying. Contact Vansah Support if the problem continues.

Example response for an invalid or already removed type:

{
"success": false,
"errorCode": 1390,
"message": "Invalid caseType identifier(c7e055f6-f32f-11ef-baf9-5a0ced9d1480)",
"data": []
}

Check success and message before continuing your integration. Share the endpoint and response with Support if needed, without your API token.

You can also view this request in the Vansah API collection in Postman.

Did this answer your question?