Use this API to rename an existing Test Case Type in a Jira space. The type keeps its identifier, and Test Cases that use that type continue to refer to the same type record.

Before you begin

Create a Vansah API token and obtain your site’s API Connect URL.
The authenticated account needs Jira administrator or space administrator permission for the target space.
Have the Jira space key and the existing type’s UUID. The lookup example below shows how to find it.

Endpoint

PUT YOUR_API_CONNECT_URL/api/v2/category/caseType/{caseTypeIdentifier}

Replace YOUR_API_CONNECT_URL with the base URL shown in Vansah settings and {caseTypeIdentifier} with the type’s existing UUID. Include the identifier at the end of the URL.

Authentication and headers

Header	Value
`Authorization`	Your Vansah API token, supplied as the header value.
`Content-Type`	`application/json` for the update request.

Request fields and validation

Field	Required	Details
`caseTypeIdentifier` (URL)	Yes	UUID of an existing, active type in the target space.
`name` (body)	Yes	New name, from 1 to 55 characters. Another active type in the same space cannot already use that name.
`project.key` (body)	Space context is required	Jira space key. The examples use DEMO. A projectKey query parameter can also provide space context.

The name is handled as plain text: HTML tags are removed and surrounding whitespace is trimmed. Supply a clear name without formatting.

Example 1: Find the type identifier

The following cURL examples use Bash syntax. Set VANSAH_URL to your base API Connect URL and VANSAH_TOKEN through your shell or pipeline’s secret settings. Replace DEMO with your Jira space key.

curl --get "$VANSAH_URL/api/v2/category/caseTypes" \
  --header "Authorization: $VANSAH_TOKEN" \
  --data-urlencode "projectKey=DEMO" \
  --data-urlencode "startAt=0" \
  --data-urlencode "limit=100"

Example response:

{
  "success": true,
  "message": "CaseTypes returned successfully",
  "pagination": {
    "total": 1,
    "startAt": 0,
    "limit": 100
  },
  "data": [
    {
      "identifier": "c7e055f6-f32f-11ef-baf9-5a0ced9d1400",
      "name": "Functional"
    }
  ]
}

Use the matching data[].identifier in the update URL. The list is sorted by name. It defaults to startAt=0 and limit=100; for additional results, increase startAt by the number of records requested until you reach pagination.total.

Example 2: Rename the type

This request changes the example type from Functional to Integration. Replace the UUID, Jira space key and name with values from your own Jira space:

curl --request PUT \
  "$VANSAH_URL/api/v2/category/caseType/c7e055f6-f32f-11ef-baf9-5a0ced9d1400" \
  --header "Authorization: $VANSAH_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"name":"Integration","project":{"key":"DEMO"}}'

The JSON body on its own is:

{
  "name": "Integration",
  "project": {
    "key": "DEMO"
  }
}

Successful response

{
  "success": true,
  "message": "Updated successfully",
  "data": {
    "identifier": "c7e055f6-f32f-11ef-baf9-5a0ced9d1400",
    "name": "Integration"
  }
}

Check that success is true. The response returns the same identifier and the saved name. You can repeat the list request to verify the name in the space.

Update behavior

The operation updates the existing type’s name rather than creating a new type.
The identifier must belong to the space supplied in the request. A type from a different space is rejected.
Deleted types are excluded from the lookup and update.
A name used by another active type in the same space is rejected as a duplicate.

Error examples and troubleshooting

For example, if another active type is already named Integration, the API returns:

{
  "success": false,
  "errorCode": 1390,
  "message": "Duplicate Case Type(Integration)",
  "data": []
}

Message or problem	How to resolve it
`Duplicate Case Type(...)`	Choose a name not used by another active type in the same space.
`Invalid caseType identifier(...)`	List the types in the target space again. Use an active type’s UUID from that response.
`One or more validation errors found.`	Read the field messages in data.errors. Check the UUID and required name.
`Case Type should be max 55 characters long`	Shorten the name to 55 characters or fewer.
`Please provide space information`	Supply valid space context and confirm that the token’s account can access that Jira space.
Authentication or permission failure	Check the token, its expiry, the site’s API URL and the account’s administrator permission.

Check the response’s success, message and any validation details before retrying.

API reference

View the request in the Vansah API documentation and Postman collection.

Update a Test Case Type (API)