addedInput schema / $defs
Added value: +{
+ "InviteOrder": {
+ "description": "Order information for invite.",
+ "properties": {
+ "order": {
+ "description": "Order number for this step",
+ "type": "integer"
+ },
+ "recipients": {
+ "description": "List of recipients for this order",
+ "items": {
+ "$ref": "#/$defs/InviteRecipient"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "order",
+ "recipients"
+ ],
+ "type": "object"
+ },
+ "InviteRecipient": {
+ "description": "Recipient information for invite.",
+ "properties": {
+ "action": {
+ "default": "sign",
+ "description": "Allowed action with a document. Possible values: 'view', 'sign', 'approve'",
+ "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"
+ },
+ "email": {
+ "description": "Recipient's email address",
+ "type": "string"
+ },
+ "message": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Custom email message for the recipient"
+ },
+ "redirect_target": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": "blank",
+ "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": "Custom email subject for the recipient"
+ }
+ },
+ "required": [
+ "email",
+ "role"
+ ],
+ "type": "object"
+ }
+}
removedInput schema / properties / entity_id / title
Removed value: -"Entity Id"
removedInput schema / properties / entity_type / title
Removed value: -"Entity Type"
removedInput schema / properties / name / title
Removed value: -"Name"
changedInput schema / properties / orders / anyOf
Previous value: -[
- {
- "items": {
- "$ref": "#/$defs/InviteOrder"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
-]New value: +[
+ {
+ "items": {
+ "$ref": "#/$defs/InviteOrder"
+ },
+ "type": "array"
+ },
+ {
+ "type": "string"
+ }
+]
removedInput schema / properties / orders / default
Removed value: -null
changedInput schema / properties / orders / description
Previous value: -"List of orders with recipients for the invite"New value: +"List of orders with recipients for the invite (can be a list or JSON string)"
addedInput schema / properties / orders / examples
Added value: +[
+ [
+ {
+ "order": 1,
+ "recipients": [
+ {
+ "action": "sign",
+ "email": "user@example.com",
+ "role": "Signer 1"
+ }
+ ]
+ }
+ ],
+ "[{\"order\": 1, \"recipients\": [{\"email\": \"user@example.com\", \"role\": \"Signer 1\", \"action\": \"sign\"}]}]"
+]
removedInput schema / properties / orders / title
Removed value: -"Orders"
changedInput schema / required
Previous value: -[
- "entity_id"
-]New value: +[
+ "entity_id",
+ "orders"
+]
removedOutput schema / properties / created_entity_id / title
Removed value: -"Created Entity Id"
removedOutput schema / properties / created_entity_name / title
Removed value: -"Created Entity Name"
removedOutput schema / properties / created_entity_type / title
Removed value: -"Created Entity Type"
removedOutput schema / properties / invite_entity / title
Removed value: -"Invite Entity"
removedOutput schema / properties / invite_id / title
Removed value: -"Invite Id"
removedOutput schema / title
Removed value: -"SendInviteFromTemplateResponse"
