OPENAPI / COMPONENTS / SCHEMAS

Embedded Edit Url Request

EmbeddedEditUrlRequest

EmbeddedEditUrlRequest data structure

object10properties
allow_edit_ccsboolean

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

cc_rolesarray

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.

editor_optionsSubEditorOptions

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.

merge_fieldsSubMergeField

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_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`.