---
title: "Get Embedded Template Edit URL"
method: POST
path: "/embedded/edit_url/{template_id}"
tags: ["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.

## Path parameters

- `template_id` string, required

## Request body

- EmbeddedEditUrlRequest
  - `allow_edit_ccs` boolean — This allows the requester to enable/disable to add or change CC roles when editing the template.
  - `cc_roles` 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` SubEditorOptions — This allows the requester to specify editor options when a preparing a document
    - `allow_edit_signers` boolean — Allows requesters to edit the list of signers
    - `allow_edit_documents` boolean — Allows requesters to edit documents, including delete and add
  - `force_signer_roles` boolean — Provide users the ability to review/edit the template signer roles.
  - `force_subject_message` boolean — Provide users the ability to review/edit the template subject and message.
  - `merge_fields` 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 `[]`.
    - `name` string, required — The name of the merge field. Must be unique.
    - `type` 'text' | 'checkbox', required — The type of merge field.
  - `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).
  - `show_preview` boolean — This allows the requester to enable the editor/preview experience.
  - `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.
  - `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`.

## Response `200`

successful operation

- EmbeddedEditUrlResponse
  - `embedded` EmbeddedEditUrlResponseEmbedded, required — An embedded template object.
    - `edit_url` string — A template url that can be opened in an iFrame.
    - `expires_at` integer — The specific time that the the `edit_url` link expires, in epoch.
  - `warnings` WarningResponse[] — A list of warnings.
    - `warning_msg` string, required — Warning message
    - `warning_name` string, required — Warning name

## Other responses

- `4XX` — failed_operation

---

[API](https://skmtc.net/hellosign/apis/dropbox-sign-api.md) · [All operations](https://skmtc.net/hellosign/apis/dropbox-sign-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hellosign/dropbox-sign-api/revisions/7535b8f1a188/schema)