Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.
Securityapi_key or oauth2
Request
path Parameters
template_id
required
string
The id of the template to edit.
Example: f57db65d3f933b5316d398057a36176831451a35
Request Body schema: application/json
allow_edit_ccs
boolean
Default: false
This allows the requester to enable/disable to add or change CC roles when editing the template.
cc_roles
Array of strings
The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request.
object (SubEditorOptions)
This allows the requester to specify editor options when a preparing a document
force_signer_roles
boolean
Default: false
Provide users the ability to review/edit the template signer roles.
force_subject_message
boolean
Default: false
Provide users the ability to review/edit the template subject and message.
Array of objects (SubMergeField)
Add additional merge fields to the template, which can be used used to pre-fill data by passing values into signature requests made with that template.
Remove all merge fields on the template by passing an empty array [].
preview_only
boolean
Default: false
This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor).
Note: This parameter overwrites show_preview=true (if set).
show_preview
boolean
Default: false
This allows the requester to enable the editor/preview experience.
show_progress_stepper
boolean
Default: true
When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.
test_mode
boolean
Default: false
Whether this is a test, locked templates will only be available for editing if this is set to true. Defaults to false.