2025-08-06

Introducing key property for Template to improve DX and consistency with other support objects (Custom properties, Document type, ...) that uses human-readable key as identifier.

Changed operations

• List all cases (GET /v1/cases)
  • ⚠️ [Added] deprecated status to data[].template_id in response body
  • ✨ [Added] required property template to data[] in response body
• Create a case (POST /v1/cases), Update a case (PATCH /v1/cases/{id})
  • ⚠️ [Added] deprecated status to template_id in request body
  • ✨ [Added] property template_key in request body
  • ⚠️ [Added] deprecated status to template_id in response body
  • ✨ [Added] required property template in response body
• Retrieve a case (GET /v1/cases/{id})
  • ⚠️ [Added] deprecated status to template_id in response body
  • ✨ [Added] required property template in response body
• List all activities (GET /v1/activities)
  • ✨ [Added] required property key to data[].context.template in response body
• List all templates (GET /v1/templates)
  • ✨ [Added] query parameter key
  • ✨ [Added] required property key to data[] in response body
• Retrieve a template (GET /v1/templates/{id})
  • ✨ [Added] required property key in response body
• Run a template (POST /v1/templates/run)
  • ⚠️ [Added] deprecated status to template_id in request body
  • ✨ [Added] property template_key in request body