removedInput schema / $defs
Removed value: -{
- "EmbeddedInviteOrder": {
- "description": "Order information for embedded invite.",
- "properties": {
- "order": {
- "description": "Order number for this step",
- "type": "integer"
- },
- "recipients": {
- "description": "List of recipients for this order",
- "items": {
- "$ref": "#/$defs/EmbeddedInviteRecipient"
- },
- "type": "array"
- }
- },
- "required": [
- "order",
- "recipients"
- ],
- "type": "object"
- },
- "EmbeddedInviteRecipient": {
- "description": "Recipient information for embedded invite.",
- "properties": {
- "action": {
- "default": "sign",
- "description": "Allowed action with a document. Possible values: 'view', 'sign', 'approve'",
- "type": "string"
- },
- "auth_method": {
- "default": "none",
- "description": "Authentication method in integrated app: 'password', 'email', 'mfa', 'biometric', 'social', 'other', 'none'",
- "type": "string"
- },
- "close_redirect_uri": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Link that opens when clicking 'Close' button"
- },
- "decline_redirect_uri": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "URL that opens after decline"
- },
- "delivery_type": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": "link",
- "description": "Invite delivery method: 'email' or 'link', use 'link' if you wand to get a link to sign. If you want to send an email, use 'email'"
- },
- "email": {
- "description": "Recipient's email address",
- "type": "string"
- },
- "first_name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Recipient's first name"
- },
- "last_name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Recipient's last name"
- },
- "message": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Invite email message (max 5000 chars)"
- },
- "redirect_target": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": "self",
- "description": "Redirect target: 'blank' for new tab, 'self' for same tab"
- },
- "redirect_uri": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Link that opens after completion"
- },
- "role": {
- "description": "Recipient's role name in the document",
- "type": "string"
- },
- "subject": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Invite email subject (max 1000 chars)"
- }
- },
- "required": [
- "email",
- "role"
- ],
- "type": "object"
- }
-}
addedInput schema / additionalProperties
Added value: +false
changedInput schema / properties / entity_id / description
Previous value: -"ID of the document or document group"New value: +"ID of the document, document group, template, or template group"
changedInput schema / properties / entity_type / anyOf
Previous value: -[
- {
- "enum": [
- "document",
- "document_group"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
-]New value: +[
+ {
+ "enum": [
+ "document",
+ "document_group",
+ "template",
+ "template_group"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+]
changedInput schema / properties / entity_type / description
Previous value: -"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."New value: +"Type of entity: 'document', 'document_group', 'template', or 'template_group' (optional). Auto-detected if not provided."
addedInput schema / properties / name
Added value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Optional name for the new document or document group (used only when entity_type is template or template_group)"
+}
removedInput schema / properties / orders / anyOf
Removed value: -[
- {
- "items": {
- "$ref": "#/$defs/EmbeddedInviteOrder"
- },
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "type": "null"
- }
-]
removedInput schema / properties / orders / default
Removed value: -null
changedInput schema / properties / orders / description
Previous value: -"List of orders with recipients (can be a list or JSON string)"New value: +"List of orders with recipients."
changedInput schema / properties / orders / examples
Previous value: -[
- [
- {
- "order": 1,
- "recipients": [
- {
- "action": "sign",
- "auth_method": "none",
- "email": "user@example.com",
- "role": "Signer 1"
- }
- ]
- }
- ],
- "[{\"order\": 1, \"recipients\": [{\"email\": \"user@example.com\", \"role\": \"Signer 1\", \"action\": \"sign\", \"auth_method\": \"none\"}]}]"
-]New value: +[
+ [
+ {
+ "order": 1,
+ "recipients": [
+ {
+ "action": "sign",
+ "auth_method": "none",
+ "email": "user@example.com",
+ "role": "Signer 1"
+ }
+ ]
+ }
+ ]
+]
addedInput schema / properties / orders / items
Added value: +{
+ "description": "Order information for embedded invite.",
+ "properties": {
+ "order": {
+ "description": "Order number for this step",
+ "type": "integer"
+ },
+ "recipients": {
+ "description": "List of recipients for this order",
+ "items": {
+ "description": "Recipient information for embedded invite.",
+ "properties": {
+ "action": {
+ "default": "sign",
+ "description": "Allowed action with a document. Possible values: 'view', 'sign', 'approve'",
+ "type": "string"
+ },
+ "auth_method": {
+ "default": "none",
+ "description": "Authentication method in integrated app: 'password', 'email', 'mfa', 'biometric', 'social', 'other', 'none'",
+ "type": "string"
+ },
+ "close_redirect_uri": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Link that opens when clicking 'Close' button"
+ },
+ "decline_redirect_uri": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "URL that opens after decline"
+ },
+ "delivery_type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": "link",
+ "description": "Invite delivery method: 'email' or 'link', use 'link' if you wand to get a link to sign. If you want to send an email, use 'email'"
+ },
+ "email": {
+ "description": "Recipient's email address",
+ "type": "string"
+ },
+ "first_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Recipient's first name"
+ },
+ "last_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Recipient's last name"
+ },
+ "message": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Invite email message (max 5000 chars)"
+ },
+ "redirect_target": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": "self",
+ "description": "Redirect target: 'blank' for new tab, 'self' for same tab"
+ },
+ "redirect_uri": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Link that opens after completion"
+ },
+ "role": {
+ "description": "Recipient's role name in the document",
+ "type": "string"
+ },
+ "subject": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Invite email subject (max 1000 chars)"
+ }
+ },
+ "required": [
+ "email",
+ "role"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "order",
+ "recipients"
+ ],
+ "type": "object"
+}
addedInput schema / properties / orders / type
Added value: +"array"
changedInput schema / required
Previous value: -[
- "entity_id"
-]New value: +[
+ "entity_id",
+ "orders"
+]
changedOutput schema / description
Previous value: -"Response model for creating embedded invite."New value: +"Response model for creating embedded invite.\n\nWhen the invite is created for a template-originated entity, the created_entity_*\nfields are populated. For direct document/document_group calls they are None."
addedOutput schema / properties / created_entity_id
Added value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "ID of the entity created from template (None when entity was document/document_group)"
+}
addedOutput schema / properties / created_entity_name
Added value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Name of the entity created from template (None when entity was document/document_group)"
+}
addedOutput schema / properties / created_entity_type
Added value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Type of created entity: 'document' or 'document_group' (None when entity was document/document_group)"
+}
addedOutput schema / properties / document_group_invite_id
Added value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "ID of the created document group embedded invite; populated only when invite_entity is 'document_group', otherwise None"
+}
removedOutput schema / properties / invite_id
Removed value: -{
- "description": "ID of the created embedded invite",
- "type": "string"
-}
changedOutput schema / properties / recipient_links / description
Previous value: -"Array of objects with role and link for recipients with delivery_type='link'"New value: +"Array of objects with role, invite id (for document invite) and link for recipients with delivery_type='link'"
changedOutput schema / required
Previous value: -[
- "invite_id",
- "invite_entity",
- "recipient_links"
-]New value: +[
+ "invite_entity",
+ "recipient_links"
+]
