> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdateTemplate # Package: studioWorkspace # Namespace: Templates # Method link: https://dev.wix.com/docs/api-reference/account-level/studio-workspace/template-v1/update-template.md ## Permission Scopes: SCOPE.STUDIO.MANAGE-CUSTOM-TEMPLATES: SCOPE.STUDIO.MANAGE-CUSTOM-TEMPLATES ## Introduction Updates a template. Each time the template is updated, `revision` increments by 1. The current `revision` must be passed when updating the template. This ensures you're working with the latest template and prevents unintended overwrites. Currently, only the template's `name` can be updated. --- ## REST API ### Schema ``` Method: updateTemplate Description: Updates a template. Each time the template is updated, `revision` increments by 1. The current `revision` must be passed when updating the template. This ensures you're working with the latest template and prevents unintended overwrites. Currently, only the template's `name` can be updated. URL: https://www.wixapis.com/wixstudio/templates/v1/templates/{template.id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: template, template.id, template.revision Method parameters: param name: template | type: Template | description: A template is a reusable starting point for creating new sites, based on an existing site. Wix Studio partners create a template from one of their sites, then use that template to create new sites within their account. Each new site is a duplicate of the template's site. A partner can also publish a template, turning it into a public template that other Wix accounts can clone. | required: true - name: id | type: string | description: Template GUID. | required: true | validation: format GUID - name: name | type: string | description: Template name. | validation: minLength 4, maxLength 20 - name: revision | type: string | description: Revision number, which increments by 1 each time the template is updated. To prevent conflicting changes, the current revision must be passed when updating the template. Ignored when creating a template. | required: true | validation: format int64 - name: templateType | type: TemplateType | description: Type of the template. - enum: - UNKNOWN: Unknown template type. - STUDIO: Standard template created from a site. - PUBLIC: Published template that other Wix accounts can clone. - name: hidden | type: boolean | description: Whether the template is hidden from template galleries and pickers. A hidden template still exists and can be used to create sites, but doesn't appear in template lists. Default: `false`. Return type: UpdateTemplateResponse - name: template | type: Template | description: Updated template. - name: id | type: string | description: Template GUID. | validation: format GUID - name: name | type: string | description: Template name. | validation: minLength 4, maxLength 20 - name: sites | type: Sites | description: Sites created from this template within the current account. - name: metaSiteIds | type: array | description: IDs of the sites created from this template within the current account. | validation: maxItems 1000, format GUID - name: count | type: integer | description: Number of sites created from this template within the current account. | validation: format int32 - name: createdBy | type: string | description: GUID of the user who created the template. | validation: format GUID - name: lastEditedBy | type: string | description: GUID of the user who last edited the template's site. | validation: format GUID - name: lastEditedDate | type: string | description: Date and time the template's site was last edited. | validation: format date-time - name: revision | type: string | description: Revision number, which increments by 1 each time the template is updated. To prevent conflicting changes, the current revision must be passed when updating the template. Ignored when creating a template. | validation: format int64 - name: createdDate | type: string | description: Date and time the template was created. | validation: format date-time - name: updatedDate | type: string | description: Date and time the template was updated. | validation: format date-time - name: templateType | type: TemplateType | description: Type of the template. - enum: - UNKNOWN: Unknown template type. - STUDIO: Standard template created from a site. - PUBLIC: Published template that other Wix accounts can clone. - name: hidden | type: boolean | description: Whether the template is hidden from template galleries and pickers. A hidden template still exists and can be used to create sites, but doesn't appear in template lists. Default: `false`. - name: platform | type: Platform | description: Platform the template's site was built on. Derived automatically from the site. - enum: - STUDIO: Site built with Wix Studio. - WIX: Site built with the Wix Editor. ``` ### Examples ### Update Template Updates a template's `name`. The current `revision` must be passed to prevent unintended overwrites. ```curl curl -X PATCH \ 'https://www.wixapis.com/wixstudio/templates/v1/templates/d7a341c4-196b-46e7-813c-2b0fb1847ec6' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ --data-binary '{ "template": { "id": "d7a341c4-196b-46e7-813c-2b0fb1847ec6", "name": "Agency Portfolio", "revision": "1" } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.templates.wixTemplatesBackend.updateTemplate(_id, template) Description: Updates a template. Each time the template is updated, `revision` increments by 1. The current `revision` must be passed when updating the template. This ensures you're working with the latest template and prevents unintended overwrites. Currently, only the template's `name` can be updated. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: template, _id, template.revision Method parameters: param name: _id | type: string | description: Template GUID. | required: true | validation: format GUID param name: template | type: UpdateTemplate | description: A template is a reusable starting point for creating new sites, based on an existing site. Wix Studio partners create a template from one of their sites, then use that template to create new sites within their account. Each new site is a duplicate of the template's site. A partner can also publish a template, turning it into a public template that other Wix accounts can clone. | required: true - name: name | type: string | description: Template name. | validation: minLength 4, maxLength 20 - name: revision | type: string | description: Revision number, which increments by 1 each time the template is updated. To prevent conflicting changes, the current revision must be passed when updating the template. Ignored when creating a template. | required: true | validation: format int64 - name: templateType | type: TemplateType | description: Type of the template. - enum: - UNKNOWN: Unknown template type. - STUDIO: Standard template created from a site. - PUBLIC: Published template that other Wix accounts can clone. - name: hidden | type: boolean | description: Whether the template is hidden from template galleries and pickers. A hidden template still exists and can be used to create sites, but doesn't appear in template lists. Default: `false`. Return type: PROMISE