v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
blueprints_Blueprints API

Updates a blueprint's top-level record by ID.

This performs a full replacement of the blueprint's editable fields using the BlueprintV2Put schema. It updates the blueprint record itself, not a specific version; to change the configuration devices actually receive, publish a new version instead.

About Update Blueprint Because Converge applies a specific version rather than the blueprint record directly, updating the blueprint itself is typically limited to metadata-level changes rather than configuration changes. If the goal is to change what devices receive (apps, files, restrictions, and so on), the correct approach is to create a new blueprint version rather than editing the existing blueprint record.

Common Use Cases

Renaming a blueprint or updating its top-level metadata

Correcting a blueprint record without affecting any of its published versions

Best Practices

Confirm whether the change belongs on the blueprint record or on a new version before calling this endpoint; device-facing configuration changes belong on a version

Provide the full set of editable fields in the request body, since this is a full replacement rather than a partial update

Workflow

Call GET /v2/blueprints/{blueprint_id}/ to review the current record

Prepare the full BlueprintV2Put payload with the updated fields

PUT to this endpoint to apply the update

Confirm the change with a follow-up GET

put/v2/blueprints/{blueprint_id}/

Path parameters

blueprint_idstring uuid required

Request body

idstring uuid
namestring

Name of the blueprint

descriptionstring

Description of the blueprint

commentsstring

Comments on the blueprint

version_numberinteger
version_idstring uuid
minor_version_numberinteger
publishboolean

Field to indicate whether to publish the blueprint

created_bystring

ID of the user who created the blueprint

updated_bystring

ID of the user who updated the blueprint

created_atstring date-time
updated_atstring date-time

Response

Success

messagestring
codestring