Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Please also see the next figure for an overview of the envelope structure:

Envelope Structure OverviewImage RemovedEnvelope Structure OverviewImage Added

For a basic guide of REST and the different API calls please also have a look at our Postman tutorial.

...

The next screenshot shows the document after sending the configuration:

Sent EnvelopeImage RemovedSent EnvelopeImage Added

With this configuration we can now add the settings which are mentioned above. First, lets start with the envelope configuration.

...

Code Block
languagejava
themeEclipse
{
	"Documents": [
		{
			"FileId": "1234ddc4-1234-1234-1234-3af31c131234",
			"DocumentNumber": 1
		}
	],
	"Name": "Test.pdf",
	"AddDocumentTimestamp": false,
	"ShareWithTeam": true,
	"LockFormFieldsOnFinish": false,
	"Activities": [
		{
			"Action": {
				"SignAutomatic": {
					"ProfileId": "12347562-1234-1234-1234-5a43184d1234",
					"RenderingLanguageCode": "EN",
					"VisibleSignatures": [
						{
							"DocumentNumber": 1,
							"UseExternalTimestampServer": false,
							"FieldDefinition": {
								"Position": {
									"PageNumber": 1,
									"X": 68.0,
									"Y": 631.8
								},
								"Size": {
									"Width": 190.0,
									"Height": 80.0
								}
							}
						}
					]
				}
			},
			"VisibilityOptions": [
				{
					"DocumentNumber": 1,
					"IsHidden": false
				}
			]
		}
	],
	"EmailConfiguration": {
		"Subject": "Please sign the enclosed envelope",
		"Message": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease

#PersonalMessage#

Please sign the envelope #EnvelopeName#\n\nEnvelope

Envelope will expire at #ExpirationDate#"
	},
	"ReminderConfiguration": {
		"Enabled": true,
		"FirstReminderInDays": 5,
		"ReminderResendIntervalInDays": 3,
		"BeforeExpirationInDays": 3
	},
	"ExpirationConfiguration": {
		"ExpirationInSecondsAfterSending": 2419200
	}
}

...

Code Block
languagejava
themeEclipse
{
	"Documents": [
		{
			"FileId": "264addc4-1234-1234-1234-3af31c13b3c2",
			"DocumentNumber": 1
		}
	],
	"Name": "Test.pdf",
	"AddDocumentTimestamp": false,
	"ShareWithTeam": true,
	"LockFormFieldsOnFinish": false,
	"Activities": [
		{
			"Action": {
				"View": {
					"RecipientConfiguration": {
						"ContactInformation": {
							"Email": "john.doe@sample.com",
							"GivenName": "John",
							"Surname": "Doe",
							"LanguageCode": "EN"
						},
						"SendEmails": true,
						"AllowAccessAfterFinish": true
					},
					"ViewingGroup": "1"
				}
			},
			"VisibilityOptions": [
				{
					"DocumentNumber": 1,
					"IsHidden": false
				}
			]
		},
		{
			"Action": {
				"SendCopy": {
					"RecipientConfiguration": {
						"ContactInformation": {
							"Email": "jane.doe@sample.com",
							"GivenName": "Jane",
							"Surname": "Doe",
							"LanguageCode": "EN"
						}
					},
					"CopyingGroup": "2"
				}
			},
			"VisibilityOptions": [
				{
					"DocumentNumber": 1,
					"IsHidden": false
				}
			]
		}
	],
	"EmailConfiguration": {
		"Subject": "Please sign the enclosed envelope",
		"Message": "Dear #RecipientFirstName# #RecipientLastName#\n\n#PersonalMessage#\n\nPlease

#PersonalMessage#

Please sign the envelope #EnvelopeName#\n\nEnvelope

Envelope will expire at #ExpirationDate#"
	},
	"ReminderConfiguration": {
		"Enabled": true,
		"FirstReminderInDays": 5,
		"ReminderResendIntervalInDays": 3,
		"BeforeExpirationInDays": 3
	},
	"ExpirationConfiguration": {
		"ExpirationInSecondsAfterSending": 2419200
	}
}

...