create_embedded_invite
Generate embedded signing invites for documents or document groups to collect electronic signatures from recipients.
Instructions
Create embedded invite for signing 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. | |
| orders | No | List of orders with recipients |
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"
},
"orders": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/EmbeddedInviteOrder"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of orders with recipients",
"title": "Orders"
}
},
"required": [
"entity_id"
],
"type": "object"
}