Edit Template
PUT {{apiBaseUrl}}/v1-beta/template/edit?templateId={{templateId}}
This API allows users to modify the properties of an existing or draft template and facilitates updates to various properties such as the title, description, and form fields associated with the template. Notably, it does not permit alterations to the files linked to the template.
Partial update
Users can execute partial updates to a template by specifying only the fields they intend to modify. The API will solely modify the specified fields, leaving the remainder unchanged. However, this is limited to top-level properties. When dealing with nested properties within top-level objects, users must provide the complete object for modification.
To update a nested property, the template properties API is used to retrieve all the properties of the given template. Then, the required properties within the nested object can modified and the updated template object is sent to the Edit Template API.
Read more about template properties API
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
templateId | string |
Request Body
{"title"=>"A new title for template", "EnableSigningOrder"=>false, "roles"=>[{"name"=>"Manager", "index"=>1, "defaultSignerName"=>"Alex", "defaultSignerEmail"=>"alexgayle@cubeflakes.com", "signerOrder"=>1, "signerType"=>"Signer", "formFields"=>[{"id"=>"Signature1", "type"=>"Signature", "isRequired"=>true, "bounds"=>{"x"=>625.0, "y"=>293.0, "width"=>124.0, "height"=>32.0}, "pageNumber"=>1}], "enableEditRecipients"=>true, "enableDeleteRecipients"=>true}], "labels"=>["label1"], "templateLabels"=>["tempLabel1"]}