create_embedded_sending
Generate embedded sending links for documents or document groups to manage, edit, or send signing invites with customizable redirect options and link expiration settings.
Instructions
Create embedded sending for managing, editing, or sending invites for 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 days (14-45) | |
| redirect_target | No | Optional redirect target: 'self' (default), 'blank' | |
| redirect_uri | No | Optional redirect URI after completion | |
| type | No | Type of sending step: 'manage', 'edit', or 'send-invite' | manage |
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": 45,
"minimum": 14,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional link expiration in days (14-45)",
"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"
},
"type": {
"anyOf": [
{
"enum": [
"manage",
"edit",
"send-invite"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "manage",
"description": "Type of sending step: 'manage', 'edit', or 'send-invite'",
"title": "Type"
}
},
"required": [
"entity_id"
],
"type": "object"
}