Sign in
optimization_templates

Update Optimization Template

Update the name and/or description of a project-level optimization template.

Parameters

template_id : str The ID of the template to update. body : UpdateOptimizationTemplate Fields to update (name, description).

Returns

OptimizationTemplate The updated template.

Raises

NotFoundError If no template with the given ID exists. ConflictError If a template with the new name already exists in the project.

patch/optimization_templates/{template_id}

Path parameters

template_idstring required

Request body

namestring nullable

The new name of the template.

descriptionstring nullable

The new optional description for the template.

initial_form_dataobject nullable

Updated initial form data values.

Response

Successful Response

namestring required

The name of the optimization template.

descriptionstring nullable

An optional description for the template.

initial_form_dataobject nullable

Initial form data values.

idstring required

The unique identifier for the template.

organization_idstring required

The ID of the organization this template belongs to.

project_idstring nullable

The ID of the owner project (None for system templates).

access_levelstring

Template scope: 'system' for built-in, 'project' for user-created.

created_atstring date-time required

Timestamp of when the template was created.

updated_atstring date-time required

Timestamp of when the template was last updated.

created_bystring nullable

User ID of the creator.

Changes