Can API IDs for Item Types and Fields Be Changed?

Published Date: April 22, 2026
Validated: Yes
Audience: Everyone
Products and Versions Covered:

Jama Connect® version(s)
Cloud/CVC
Self-hosted

IMPORTANT: Access to the REST API and the Jama Connect Cloud MCP Server is restricted to users with a Named Creator Jama Connect license, which includes access to v1, Labs, and SCIM endpoints. Users without a Named Creator license—including those with a Creator Float license—do not have access.

Summary

In Jama Connect, API IDs cannot be changed after they are created. This applies to all object types, including item types, fields, sets, folders, and items.

This can be limiting when managing multiple instances or using integrations that depend on having the same API IDs across environments. To use a different API ID, the object must be recreated.

For fields, additional steps may be needed to keep existing data.

Resolution

If you need a different API ID

API IDs cannot be modified after creation. They are system-generated and cannot be customized. To use a different API ID, you must recreate the item type, field, or other object. A new API ID will be automatically assigned.

After recreating it, update any integrations or scripts to reference the new API ID.

If you need to keep existing field data

If a field must be replaced, use a roundtrip export to move data from the old field to the new one.

Export the relevant items, map the old field values to the new field, and re-import the data.

Note that this can require additional effort for large datasets.

If this is for integrations or automation

If this is for integrations or automation, API IDs are instance-specific and cannot be aligned across environments.

For more tailored guidance, you can engage with our Solutions team to explore the best approach for your setup.

Additional Resources

Feedback:
We welcome your input! Please sign in to leave any comments, suggestions, or ideas for improvement below.

Related to