v1

latestOpenAPI 3.0.3MIT2026-07-1373217576.0 KB

Embedded

Get Embedded Template Edit URL

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.

post/embedded/edit_url/{template_id}

Path parameters

template_idstring required

The id of the template to edit.

Request body

allow_edit_ccsboolean

This allows the requester to enable/disable to add or change CC roles when editing the template.

cc_rolesstring[]

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.

force_signer_rolesboolean

Provide users the ability to review/edit the template signer roles.

force_subject_messageboolean

Provide users the ability to review/edit the template subject and message.

preview_onlyboolean

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_previewboolean

This allows the requester to enable the editor/preview experience.

show_progress_stepperboolean

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_modeboolean

Whether this is a test, locked templates will only be available for editing if this is set to true. Defaults to false.

Response

successful operation