Embedded

Get Embedded Template Edit URL

POST
/embedded/edit_url/{template_id}

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.

Authorization

AuthorizationBasic <token>

Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information. āœ… Supported by Try it console (calls sent in test_mode only).

In: header

Path Parameters

template_id*string

The id of the template to edit.

Request Body

application/json

allow_edit_ccs?boolean

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

Defaultfalse
cc_roles?array<string>

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_options?

This allows the requester to specify editor options when a preparing a document

force_signer_roles?boolean

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

Defaultfalse
force_subject_message?boolean

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

Defaultfalse
merge_fields?array<>

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

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).

Defaultfalse
show_preview?boolean

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

Defaultfalse
show_progress_stepper?boolean

When only one step remains in the signature request process and this parameter is set to false then the progress stepper will be hidden.

Defaulttrue
test_mode?boolean

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

Defaultfalse

Response Body

application/json

application/json

curl -X POST "https://example.com/embedded/edit_url/f57db65d3f933b5316d398057a36176831451a35" \  -H "Content-Type: application/json" \  -d '{    "cc_roles": [      ""    ],    "merge_fields": []  }'
{  "embedded": {    "edit_url": "https://app.hellosign.com/editor/embeddedTemplate?token=70ca8e5779c9a931125db09f3170efc1&amp;root_snapshot_guids[]=a97ce534aec6cbe09e70cdd55112e31bd320ed00&amp;edited_template_guid=61a832ff0d8423f91d503e76bfbcc750f7417c78&amp;guid=56ecaf0659aa29215d2ee489c0c88ff8c9496099&amp;force_signer_input=1",    "expires_at": 1634313821  }}