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.

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API; the Hub provides documentation and a local SDK/CLI only.

Request

operationId: embeddedEditUrl
Server: https://api.hellosign.com/v3
Authentication: api_key, oauth2

Request parameters

`template_id`

pathstringrequired

The id of the template to edit.

f57db65d3f933b5316d398057a36176831451a35

Request body

EmbeddedEditUrlRequestrequired

Content-Type: application/json

Properties: allow_edit_ccscc_roleseditor_optionsforce_signer_rolesforce_subject_messagemerge_fieldspreview_onlyshow_previewshow_progress_steppertest_mode

{
  "allow_edit_ccs": false,
  "cc_roles": [
    {}
  ],
  "editor_options": {
    "allow_edit_signers": false,
    "allow_edit_documents": false
  },
  "force_signer_roles": false,
  "force_subject_message": false,
  "merge_fields": [
    {
      "name": "Example Name",
      "type": "text"
    }
  ],
  "preview_only": false,
  "show_preview": false
}

Responses

`200`

EmbeddedEditUrlResponseapplication/json

successful operation

Properties: embeddedwarnings

`4XX`

ErrorResponseapplication/json

failed_operation

Properties: error

{
  "embedded": {
    "edit_url": "https://example.com/resource",
    "expires_at": 0
  },
  "warnings": [
    {
      "warning_name": "Example Name"
    }
  ]
}