Page History

Note the following regarding AgentRedirectConfiguration:

•  Draft/create
  • If Allow flag is set to false, Policy and IFrameAllowList should be null
• Draft/Update
  • If Allow flag is set to false,
    • Policy and IFrameAllowList should be null
    • If it is valid, then Policy and IFrameAllowList are reset to default

"AgentRedirectConfiguration": {
    "Policy": "Workflow",
    "Allow": false,
    "IFrameAllowList": []
  }

RedirectPolicy values:

• "Workflow" → redirects to the create envelope page
• "FormEditor" → redirects to the designer page
• "Summary" → redirects to the envelope summary page

It is allowed to define placeholders on a template, create a draft still with unresolved placeholders using the POST v6/template/createdraft method and retrieve placeholder information from the draft using GET /v6/draft/{id}. Placeholders need to be replaced before sending the draft.

{
    "Documents": [{
            "FileId": "19b7a4b4-1234-1234-1234-daa50efde453",
            "DocumentNumber": 1
        }
    ],
    "Name": "DraftCreate",
    "Activities": [{
            "Action": {
                "Sign": {
                    "RecipientConfiguration": {
                        "ContactInformation": {
                            "Email": "janedoe@sample.com",
                            "GivenName": "Jane",
                            "Surname": "Doe",
                            "LanguageCode": "EN",
                            "PhoneNumber":"+123456789"
                        }
                    },
                    
                    "Elements": {
                        "Signatures": [{
                                "TaskConfiguration": {
                                    "OrderDefinition": {
                                        "OrderIndex": 0
                                    }
                                },
                                "ElementId": "sample sig ClickToSign",
                                "Required": true,
                                "DocumentNumber": 1,
                                "DisplayName": "Sign here",
                                "AllowedSignatureTypes": {
                                    "ClickToSign": {
                                    }
                            

{
    "Name": "test",
    "SignEmailOptions": {
        "EmailSubject": "Please sign the enclosed envelope",
        "EmailBody": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease sign the envelope #EnvelopeName#\n\nEnvelope will expire at #ExpirationDate#",
        "DisplayedEmailSender": "demo.esignanywhere.net"
    },
    "LockAllFormFieldsOnEnvelopeFinish": true,
    "SendCopyToAllSigners": false,
    "ValidityFromCreationInDays": 0,
    "CreationDate": "2020-12-10T14:31:08.377+00:00",
    "ReminderConfiguration": {
        "Enabled": true,
        "InitialReminderInDays": 5,
        "RecurrentReminderInDays": 3,
        "LastReminderBeforeExpirationInDays": 3
    },
    "CallbackConfiguration": {
          "AfterSendCallbackUrl": "string",
        "EnvelopeFinishCallbackUrl": "",
        "StatusUpdateCallbackUrlFieldDefinition": ""{
    },
     "RedirectConfiguration": {
        "AfterSendRedirectUrl": "string"
    },
    "AgentConfiguration": {
        "LandingPagePosition": "ToRecipients",{
        "Enabled": true,
        "AllowedUrisForIframe": [
            "string"
        ]
    }"PageNumber": 1,
    "AuditLogConfiguration": {
          "EnvelopeLog": false,
        "AttachSignedDocumentsToAuditLog": false
    },
    "Documents": [
        {"X": 100,
            "Id": "##Id##",
               "OrderIndex": 1,
            "FileNameY": "Test.pdf",200
            "DocumentSizes": [
                  {
      },
              "PageNumber": 1,
                      "DocumentSizeInPointsSize": {
                        "Height": 792.0,
               "Width": 100,
        "Width": 612.0
                    }
           "Height": 70
    }
            ],
            "TextFields": [],
       }
     "RadioButtonGroups": [],
            "CheckBoxes": [],
            "ListBoxes": [], }
            "ComboBoxes": [],
               "TypeWriterAnnotations": [], }
            "Attachments": [],
            "SignatureFields": [],
            "ServiceSignatureFields": []
        },
    ],
    "Recipients": [
        {
   "SigningGroup": "firstSigner"
        "Id": "##Id##",
       }
     "OrderIndex": 1,
      }
      "Email": "##EMAIL##",  }
    ]
}

{
        "LanguageCodeDocuments": "en",
[{
            "PlaceholderFileId": false"075f6443-9d96-43d4-9c41-6957fafa44d1",
            "AllowDelegationDocumentNumber": true,1
        }
    "Bulk": false],
        "Name": "DraftCreate",
    "ParallelActivities": false,[{
            "TypeAction": "Signer",{
                "EmailSettingsSign": {
                    "SendEmailRecipientConfiguration": true,{
                "AddAndroidAppLink": false,
        "ContactInformation": {
           "AddIosAppLink": false,
                "AddWindowsAppLinkEmail": false"jane.doe@sample.com",
                "PersonalMessage": ""
            }"GivenName": "Jane",
            "Authentication": {
                "WindowsLiveSurname": false"Doe",
                "OAuthAuthentications": [],
                "SamlAuthenticationsLanguageCode": []"EN",
            },
                "DocumentOptionsPhoneNumber": [
"+123456789"
                        {}
                    "DocumentOrderIndex": 1},
                    "Visible": true
                    "Elements": }{
            ],
            "ServiceTasksSignatures": [{
                "ApplyTimestampOnDocument": false,
                "SigningPluginServiceTasksTaskConfiguration": [],{
                "SwissComServiceRemoteSealingTasks": [],
                    "NamirialServiceRemoteSealingTasksOrderDefinition": []{
            },
            "Agreements": [
               "OrderIndex": {0
                    "Languages": [
               }
         {
                       },
     "LanguageCode": "en",
                            "TextElementId": "Signaturesample Disclosuresig TextClickToSign",
                                "HeaderRequired": "Signaturetrue,
 Disclosure Subject"
                        }
      "DocumentNumber": 1,
             ]
                }
   "DisplayName": "Sign here",
       ]
        },
        {
            "IdAllowedSignatureTypes": "##Id##",{
            "OrderIndex": 2,
            "Email": "##EMAIL##",
            "LanguageCodeClickToSign": "en",{
             "Placeholder": false,
            "AllowDelegation": false,
            "Bulk": false,
              "Parallel": false,
            "Type": "Cc",
        },
    "EmailSettings": {
                "SendEmail": true,
                "AddAndroidAppLinkDrawToSign": false,{
                "AddIosAppLink": false,
                "AddWindowsAppLink": false,
      
          "PersonalMessage": ""
            },
            "Authentication": {}
                "WindowsLive": false,
                "OAuthAuthentications": []},
                "SamlAuthentications": []
            },
            "DocumentOptions"FieldDefinition": [{
                {
                    "DocumentOrderIndexPosition": 1,{
                       "Visible": true
                  }"PageNumber": 1,
            ],
            "ServiceTasks": {
                "ApplyTimestampOnDocumentX": false100,
                "SigningPluginServiceTasks": [],
                  "SwissComServiceRemoteSealingTasks      "Y": [],
200
                   "NamirialServiceRemoteSealingTasks": []
                 },
            "Agreements": [
                        "Size": {
                    "Languages": [
                    "Width": 100,
     {
                                   "LanguageCodeHeight": "en",
70
                                    }
                                }
                            }
                               
                        ]
                    },
                     
                    "SigningGroup": "firstSigner"
                }
               
            }
        }
        
    ],
    "DefaultSignatureTypeConfiguration": {
    "ClickToSign": {
      "IsDefault": false
    },
    "DrawToSign": {
      "IsDefault": true
    },
    "TypeToSign": {
      "IsDefault": false
    },
    "LocalCertificate": {
      "IsDefault": false
    },
    "DisposableCertificate": {
      "IsDefault": false
    },
    "Biometric": {
      "IsDefault": false
    },
    "RemoteCertificate": {
      "IsDefault": false
    },
    "OneTimePassword": {
      "IsDefault": false
    }
                     }
}

{
    "Id": "3a086823-1234-1234-1234-6af6235b528b",
    "Name": "DraftCreate",
    "Activities": [
        {
            "Id": "12f67be4-1234-1234-1234-3907f818b2ec",
            "Action": {
                "Sign": {
                    "SigningGroup": 1,
                    "ContactInformation": {
                        "Email": "janedoe@sample.com",
                        "GivenName": "Jane",
                        "Surname": "Doe",
                        "PhoneNumber": "+123456789",
                        "LanguageCode": "EN"
                    }
                }
            }
        }
    ]
}

Even if only an empty string for e.g. "Name" is entered, the value of the draft will be adjusted. Therefore, after the update call the draft name would be "". If you do not want certain data from the draft to be changed by the update call, then do not include the value in the json structure. This keeps the value of the draft before updating it and only those declared in the json are changed.

{
  "DraftId": "string",
  "TextName": "Signature Disclosure Textstring",
                            "HeaderMetaData": "Signature Disclosure Subjectstring",
  "AddDocumentTimestamp": true,
                     }
   "ShareWithTeam": true,
  "LockFormFieldsOnFinish": true,
  "SendFinishedDocumentsToAllSignersAndMustView": true,
  "EmailConfiguration": {
    "Subject": "string",
    "Message": "string",
    "SenderDisplayName": "string"
  ]},
  "ReminderConfiguration": {
    "Enabled": true,
    "FirstReminderInDays": 0,
   }
    "ReminderResendIntervalInDays": 0,
    "BeforeExpirationInDays": 0
    ]},
  "ExpirationConfiguration": {
     }"ExpirationInSecondsAfterSending": 0,
    ]
}

{
  "DraftId": "string"
}