create_embedded_editor
Generate an embedded editor to modify documents or document groups directly within your application for electronic signature workflows.
Instructions
Create embedded editor for editing a document or document group
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| entity_id | Yes | ID of the document or document group | |
| entity_type | No | Type of entity: 'document' or 'document_group' (optional). If you're passing it, make sure you know what type you have. If it's not found, try using a different type. | |
| link_expiration | No | Optional link expiration in minutes (15-43200) | |
| redirect_target | No | Optional redirect target: 'self' (default), 'blank' | |
| redirect_uri | No | Optional redirect URI after completion |
Input Schema (JSON Schema)
{
"properties": {
"entity_id": {
"description": "ID of the document or document group",
"title": "Entity Id",
"type": "string"
},
"entity_type": {
"anyOf": [
{
"enum": [
"document",
"document_group"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Type of entity: 'document' or 'document_group' (optional). If you're passing it, make sure you know what type you have. If it's not found, try using a different type.",
"title": "Entity Type"
},
"link_expiration": {
"anyOf": [
{
"maximum": 43200,
"minimum": 15,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional link expiration in minutes (15-43200)",
"title": "Link Expiration"
},
"redirect_target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional redirect target: 'self' (default), 'blank'",
"title": "Redirect Target"
},
"redirect_uri": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional redirect URI after completion",
"title": "Redirect Uri"
}
},
"required": [
"entity_id"
],
"type": "object"
}