Foxit eSign (Vorschau)

Foxit eSign ist eine lösung für elektronische Signaturen, mit der Sie Dokumente online senden, signieren und verwalten können , was das Drucken, Scannen oder Versenden von Sendungen nicht mehr benötigt. Laden Sie Ihr Dokument hoch, definieren Sie Signaturfelder, und senden Sie es an Empfänger für schnelle, rechtsverbindliche eSignaturen.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Service	Class	Regions
Copilot Studio	Premium	Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Logik-Apps	Standard	Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: - Azure Government Regionen - Azure China-Regionen - US Department of Defense (DoD)
Power Apps	Premium	Alle Power Apps Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)
Power Automate	Premium	Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD)

Kontakt
Name	Foxit eSign Support
URL	https://www.foxit.com
Email	api@foxit.com

Connectormetadaten
Herausgeber	Foxit Software Inc.
Website	https://www.foxit.com/esign-pdf/
Datenschutzrichtlinie	https://www.foxit.com/company/privacy-policy.html
Kategorien	Produktivität; Inhalt und Dateien

Foxit eSign

Foxit eSign ist eine elektronische Signaturlösung auf Unternehmensniveau, die es Unternehmen ermöglicht, rechtsverbindliche Dokumente vollständig online zu senden, zu signieren und zu verwalten . Die Notwendigkeit von Drucken, Scannen oder Sendungen wird eliminiert. Laden Sie Ihr Dokument hoch, definieren Sie Signaturfelder, und senden Sie es an Empfänger für schnelle, sichere eSignaturen. Foxit eSign ist vollständig konform mit wichtigen elektronischen Signaturgesetzen, einschließlich ESIGN und UETA, verwendet Verschlüsselung zum Schutz von Dokumenten während der Übertragung und im Ruhezustand und unterstützt die mehrstufige Authentifizierung, um sicherzustellen, dass nur autorisierte Signierer auf Ihre Dokumente zugreifen und signieren können.

Der Foxit eSign-Connector für Microsoft Power Automate ermöglicht es Ihnen, den vollständigen Dokumentsignierungsworkflow zu automatisieren – vom Erstellen von Umschlägen und senden sie für die Signatur, zum Nachverfolgen des Status, zum Herunterladen abgeschlossener Dokumente, zum Verwalten von Vorlagen und zum Auslösen von Downstreamaktionen, wenn Umschlagereignisse auftreten.

Publisher: Foxit Corporation

Voraussetzungen

Um diesen Connector zu verwenden, benötigen Sie Folgendes:

Ein Microsoft Power Apps- oder Power Automate-Plan mit benutzerdefiniertem Connector- oder Premium-Connectorzugriff
Ein Foxit eSign-Konto – hier erstellen
API-Zugriff auf Ihr Foxit eSign-Konto aktiviert (siehe Abrufen von Anmeldeinformationen unten)

Abrufen von Anmeldeinformationen

Erstellen Sie ein Foxit eSign-Konto , wenn Sie noch keins haben.
Wenden Sie sich an das Foxit Sales-Team, um den API-Zugriff auf Ihr Konto anzufordern. Nach der Genehmigung wird der API-Zugriff auf Ihr Konto aktiviert.
Suchen Sie in Power Automate in der Connectorliste nach Foxit eSign, und wählen Sie "Verbindung erstellen" aus.
Sie werden zur Foxit eSign-Anmeldeseite umgeleitet. Melden Sie sich mit Ihren Foxit eSign-Anmeldeinformationen an, um die Verbindung zu autorisieren.
Nach der Autorisierung kann die Verbindung in Ihren Flüssen verwendet werden.

Getting Started

Nach dem Erstellen einer Verbindung können Sie mit dem Erstellen von Flüssen mit dem Foxit eSign-Connector beginnen:

Verwenden Sie Trigger , um einen Fluss automatisch zu starten, wenn ein Umschlagereignis auftritt (z. B. wenn alle Parteien signiert wurden).
Verwenden Sie Aktionen zum Erstellen von Umschlägen, Senden von Signaturerinnerungen, Herunterladen abgeschlossener Dokumente, Verwalten von Vorlagen und mehr.
Verketten Sie mehrere Aktionen , z. B. erstellen Sie einen Umschlag aus einer Vorlage, warten Sie auf den vollständig ausgeführten Auslöser, und laden Sie das signierte Dokument herunter, und speichern Sie es in SharePoint.

Unterstützte Trigger

Schalter	Description
Wenn ein Umschlag gesendet wird	Wird ausgelöst, wenn ein Umschlag an Empfänger gesendet wird. Erfordert webhook Level set to Account.
Wenn ein Umschlag angezeigt wird	Wird ausgelöst, wenn ein Empfänger den Umschlag öffnet und anzeigt.
Wenn ein Umschlag signiert ist	Wird ausgelöst, wenn ein Empfänger den Umschlag signiert.
Wenn ein Umschlag abgebrochen wird	Wird ausgelöst, wenn ein Umschlag von einem Empfänger oder dem Absender abgebrochen wird.
Wenn ein Umschlag vollständig ausgeführt wird	Wird ausgelöst, wenn alle Empfänger signiert sind und der Umschlag vollständig abgeschlossen ist.
Wenn ein Umschlag gelöscht wird	Wird ausgelöst, wenn ein Umschlag gelöscht wird.

Unterstützte Aktionen

Briefumschläge

Aktivität	Description
Briefumschlag aus URL erstellen	Erstellt und sendet einen Umschlag mithilfe einer öffentlich zugänglichen PDF-URL.
Briefumschlag aus Base64 erstellen	Erstellt und sendet einen Umschlag mit einem Base64-codierten PDF-Dokument.
Umschlag aus Vorlage erstellen	Erstellt und sendet einen Umschlag aus einer vorhandenen Foxit eSign-Vorlage.
Briefumschlagdetails abrufen	Ruft die vollständigen Details und den aktuellen Status eines Umschlags ab.
Umschlag-IDs abrufen	Ruft eine Liste von Umschlag-IDs basierend auf Filterkriterien ab.
Signaturerinnerung senden	Sendet eine Erinnerungsbenachrichtigung an ausstehende Signierer eines Umschlags.
Umschlagdateien herunterladen	Lädt alle signierten Dokumente in einem Umschlag als ZIP-Datei herunter.
Pdf-Datei für einzelne Dokumente herunterladen	Lädt ein einzelnes Dokument aus einem Umschlag als PDF herunter.
Umschläge in den Papierkorb verschieben	Verschiebt einen oder mehrere Umschläge in den Papierkorb.
Umschlag abbrechen	Bricht einen Umschlag ab und benachrichtigt Empfänger.
Umschläge löschen	Löscht dauerhaft einen oder mehrere Umschläge.
Abrufen des Umschlagaktivitätsverlaufs	Ruft das vollständige Aktivitätsprotokoll für einen Umschlag ab.
Löschen des Umschlagverlaufs abrufen	Ruft den Verlauf gelöschter Umschläge im Konto ab.

Templates

Aktivität	Description
Vorlage aus URL erstellen	Erstellt eine wiederverwendbare Signaturvorlage mithilfe einer öffentlich zugänglichen PDF-URL.
Vorlage aus Base64 erstellen	Erstellt eine wiederverwendbare Signaturvorlage mit einem base64-codierten PDF-Dokument.
Vorlagendetails abrufen	Ruft die vollständigen Details einer bestimmten Vorlage einschließlich Felddefinitionen ab.
Vorlagen nach Vorlagen-IDs abrufen	Ruft Details für eine oder mehrere Vorlagen anhand ihrer IDs ab.
Abrufen einer Liste aller Vorlagen	Ruft alle vorlagen ab, die im Konto verfügbar sind.

Webhooks

Aktivität	Description
Alle Webhook-Kanäle auflisten	Gibt eine Liste aller webhook-Kanäle zurück, die im Konto konfiguriert sind.
Abrufen von Webhook-Kanaldetails	Ruft die Details eines bestimmten Webhook-Kanals ab.

E-Mail-Gruppen

Aktivität	Description
E-Mail-Gruppe erstellen	Erstellt eine neue E-Mail-Gruppe zur Verwendung als Empfänger in Umschlägen.
E-Mail-Gruppendetails abrufen	Ruft die Details und Mitglieder einer E-Mail-Gruppe ab.

Berichte

Aktivität	Description
Bericht herunterladen	Lädt einen Kontoaktivitätsbericht im Microsoft Excel Format herunter.

Bekannte Probleme und Einschränkungen

Rate Limit: Die Foxit eSign-API ermöglicht bis zu 4.000 Anforderungen pro 5 Minuten pro Konto. Anforderungen, die diesen Grenzwert überschreiten, erhalten eine 429 Too Many Requests Antwort. Es wird empfohlen, Wiederholungslogik mit exponentiellem Backoff in Ihren Flüssen zu implementieren, um dies ordnungsgemäß zu behandeln.
Dateigrößenbeschränkung: Die maximale Dateigröße pro Dokument beträgt 25 MB. Dieser Grenzwert gilt für einzelne Dateien, nicht für die Gesamtumschlaggröße.
Automatisches Abmelden von Webhook: Aufgrund einer Einschränkung in der Foxit eSign-Webhook-Lösch-API (die eine POST-Methode anstelle von DELETE verwendet), können Power Automate Webhook-Kanalabonnements nicht automatisch bereinigen, wenn ein triggerbasierter Fluss gelöscht oder geändert wird. Verwenden Sie die Aktion "Alle Webhook-Kanäle auflisten", um aktive Kanäle und das Foxit eSign-Portal zu identifizieren, um Abonnements zu entfernen, wenn ein Fluss außer Betrieb genommen wird.
Wenn ein Umschlag gesendet wird – Nur Kontoebene: Der Trigger "Wenn ein Umschlag gesendet wird" wird nur ausgelöst, wenn die Webhook-Ebene auf "Account" festgelegt ist. Es wird nicht für Umschläge ausgelöst, die auf API-App-Ebene erstellt wurden. Stellen Sie sicher, dass Sie beim Konfigurieren dieses Triggers die Kontoebene auswählen.
Regionale Verfügbarkeit: Der Connector ist sowohl für Nordamerika-Konten (NA1) als auch für EU-Regionskonten verfügbar. Wählen Sie beim Konfigurieren der Verbindung die entsprechende Serverregion aus. Die Verbindung mit der falschen Region führt zu Authentifizierungsfehlern.
Base64-Dokumentgröße: Bei Verwendung des Umschlags aus Base64- oder "Vorlage erstellen" aus Base64-Aktionen muss die base64-codierte Zeichenfolge einer Quelldatei entsprechen, die maximal 25 MB groß ist.

Support

Wenden Sie sich für den Entwicklersupport an das Foxit eSign-Team unter devsupport@foxitsoftware.com.

Um einen Supportfall zu übermitteln, besuchen Sie https://kb.foxit.com/s/submit-a-case.

Drosselungsgrenzwerte

Name	Aufrufe	Verlängerungszeitraum
API-Aufrufe pro Verbindung	100	60 Sekunden

Aktionen

Abrufen des Umschlagaktivitätsverlaufs	Ruft ein vollständiges Aktivitätsprotokoll für einen Umschlag ab und zeigt alle Aktionen an, die von Empfängern und dem Absender ausgeführt wurden.
Abrufen einer Liste aller Vorlagen	Gibt eine Liste aller vorlagen zurück, die in Ihrem Konto verfügbar sind.
Abrufen von Webhook-Kanaldetails	Ruft die Details eines bestimmten Webhook-Kanals ab.
Alle Webhook-Kanäle auflisten	Gibt eine Liste aller webhook-Kanäle zurück, die in Ihrem Konto konfiguriert sind.
Bericht herunterladen	Lädt einen Umschlagaktivitätsbericht als Microsoft Excel Datei herunter. Verwenden Sie die Filter, um Ergebnisse nach Status, Datumsbereich, Umschlagname, Autor oder Signierer einzugrenzen.
Briefumschlag aus Base64 erstellen	Erstellt und sendet einen Umschlag mit einem Base64-codierten PDF-Dokument.
Briefumschlag aus URL erstellen	Erstellt und sendet einen Umschlag mithilfe öffentlich zugänglicher PDF-URLs. Geben Sie die Dokument-URLs und Empfängerdetails an, um den Signiervorgang zu initiieren.
Briefumschlag-IDs abrufen	Gibt eine Liste von Umschlag-IDs zurück, die nach Status gefiltert werden. Verwenden Sie diese Option, um Umschläge in einem bestimmten Zustand zu finden.
Briefumschlagdetails abrufen	Ruft vollständige Details eines Umschlags ab, einschließlich status, Empfänger und Dokumente.
E-Mail-Gruppe erstellen	Erstellt eine neue E-Mail-Gruppe, mit der Briefumschläge gleichzeitig an mehrere Empfänger gesendet werden können.
E-Mail-Gruppendetails abrufen	Ruft Details einer vorhandenen E-Mail-Gruppe ab.
Löschen des Umschlagverlaufs abrufen	Ruft einen Verlauf von Umschlägen ab, die gelöscht oder in den Papierkorb verschoben wurden.
Pdf-Datei für einzelne Dokumente herunterladen	Lädt ein einzelnes Dokument aus einem Umschlag als PDF-Datei herunter.
Signaturerinnerung senden	Sendet eine Erinnerungsbenachrichtigung an ausstehende Empfänger eines Umschlags und fordert sie auf, die Signatur abzuschließen.
Umschlag abbrechen	Bricht einen gesendeten Umschlag ab. Empfänger können die Dokumente nicht mehr signieren.
Umschlag aus Vorlage erstellen	Erstellt und sendet einen Umschlag mithilfe einer vorhandenen Vorlage. Empfängerdetails können angepasst werden.
Umschlagdateien herunterladen	Lädt die abgeschlossenen Dokumente aus einem Umschlag als Datei herunter.
Umschläge in den Papierkorb verschieben	Verschiebt einen oder mehrere Umschläge in den Papierkorb. Umschläge im Papierkorb werden nicht dauerhaft gelöscht.
Umschläge löschen	Löscht dauerhaft einen oder mehrere Umschläge.
Vorlage aus Base64 erstellen	Erstellt eine neue Vorlage mit einer base64-codierten PDF-Zeichenfolge. Verwenden Sie dies, wenn Ihre PDF-Datei bereits als Base64-Zeichenfolge in Ihrem Fluss verfügbar ist, z. B. aus einer SharePoint Datei oder OneDrive Dokument.
Vorlage aus URL erstellen	Erstellt eine neue Vorlage mithilfe einer öffentlich zugänglichen PDF-URL.
Vorlagen nach Vorlagen-IDs abrufen	Ruft Details für eine oder mehrere Vorlagen anhand ihrer IDs ab.
Vorlagendetails abrufen	Ruft die vollständigen Details einer bestimmten Vorlage ab, einschließlich der Felder und Empfänger.
Webhook-Trigger kündigen	Löscht ein aktives Webhook-Kanalabonnement anhand seiner Kanal-ID. Verwenden Sie diese Aktion, um Webhook-Abonnements zu bereinigen, die nicht mehr benötigt werden.

Abrufen des Umschlagaktivitätsverlaufs

Vorgangs-ID:: GetEnvelopeActivityHistory

Ruft ein vollständiges Aktivitätsprotokoll für einen Umschlag ab und zeigt alle Aktionen an, die von Empfängern und dem Absender ausgeführt wurden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschlag-ID	folderId	True	integer	Der eindeutige Bezeichner des Umschlags, dessen Aktivitätsverlauf Sie abrufen möchten.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
Umschlag-ID	details.folderId	integer	Der eindeutige Bezeichner des Umschlags.
Eingeschlossene Dokumente	details.enclosedDocuments	string	Der Name der Dokumente, die in den Umschlag eingeschlossen sind.
Empfänger	details.envelopeRecipients	string	Die Namen aller Empfänger auf dem Umschlag.
Autor	details.author	string	Der Name des Benutzers, der den Umschlag erstellt hat.
Status	details.status	string	Der aktuelle Status des Umschlags (z. B. FREIGEGEBEN, AUSGEFÜHRT, ABGEBROCHEN).
Neuestes Aktivitätsdatum	details.latestActivityDate	string	Das Datum und die Uhrzeit der letzten Aktivität auf dem Umschlag.
Erstellt am	details.dateCreated	string	Das Datum und die Uhrzeit der Erstellung des Umschlags.
Gesendetes Datum	details.dateSent	string	Das Datum und die Uhrzeit, zu dem der Umschlag an empfänger gesendet wurde.
Activities	details.activities	array of object	Die chronologische Liste aller Aktionen, die auf diesem Umschlag ausgeführt werden.
Activity	details.activities.activity	string	Eine lesbare Beschreibung der Aktion, die aufgetreten ist.
Aktivität	details.activities.action	string	Der Typ der ausgeführten Aktion (z. B. "Erstellt", "Einladung gesendet", "Geöffnet", "Angezeigt", "Signiert").
Benutzer	details.activities.user	string	Der Name des Benutzers, der die Aktion ausgeführt hat.
Umschlagstatus	details.activities.folderStatus	string	Der Status des Umschlags zum Zeitpunkt dieser Aktion.
Uhrzeit	details.activities.time	string	Das Datum und die Uhrzeit, zu dem die Aktion aufgetreten ist.
Grundlage	details.activities.source	string	Die Quelle, aus der die Aktion ausgeführt wurde (z. B. Web).
IP-Adresse	details.activities.ipAddress	string	Die IP-Adresse, von der die Aktion ausgeführt wurde, falls verfügbar.

Abrufen einer Liste aller Vorlagen

Vorgangs-ID:: GetalistofallTemplates

Gibt eine Liste aller vorlagen zurück, die in Ihrem Konto verfügbar sind.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
Gesamtvorlagen	total_templates	integer	Die Gesamtzahl der Vorlagen in Ihrem Konto.
Vorlagenliste	templatesList	array of object	Die Liste aller vorlagen, die im Konto verfügbar sind.
Vorlagen-ID	templatesList.templateId	integer	Der eindeutige Bezeichner der Vorlage. Verwenden Sie diese ID mit "Umschlag aus Vorlage erstellen", um die Vorlage zum Signieren zu senden.
Vorlagenname	templatesList.templateName	string	Der Name der Vorlage.
Vorlagenbeschreibung	templatesList.templateDesc	string	Eine Beschreibung der Vorlage.
Vorlagentyp	templatesList.templateType	string	Der Typ oder die Kategorie der Vorlage.
Erstellungsdatum	templatesList.templateCreationDate	integer	Das Datum, an dem die Vorlage erstellt wurde, in Unix Millisekunden.
Datum der letzten Aktualisierung	templatesList.templateLastUpdateDate	integer	Das Datum, an dem die Vorlage zuletzt aktualisiert wurde, in Unix Millisekunden.
Bearbeitbar	templatesList.editable	boolean	Gibt an, ob die Vorlage bearbeitet werden kann.
Anzahl der Parteien	templatesList.numberOfParties	integer	Die Anzahl der in der Vorlage definierten Signaturparteien.
Unternehmens-ID	templatesList.companyId	integer	Das Firmenkonto, zu dem die Vorlage gehört.
Für alle freigeben	templatesList.shareAll	boolean	Gibt an, ob die Vorlage für alle Benutzer im Konto freigegeben wird.
Partei-ID	templatesList.templateCreatedBy.partyId	integer	Der eindeutige Bezeichner des Benutzers.
Vorname	templatesList.templateCreatedBy.firstName	string	Der Vorname des Benutzers.
Nachname	templatesList.templateCreatedBy.lastName	string	Der Nachname des Benutzers.
Email	templatesList.templateCreatedBy.emailId	string	Die E-Mail-Adresse des Benutzers.
Partei-ID	templatesList.templateLastUpdatedBy.partyId	integer	Der eindeutige Bezeichner des Benutzers.
Vorname	templatesList.templateLastUpdatedBy.firstName	string	Der Vorname des Benutzers.
Nachname	templatesList.templateLastUpdatedBy.lastName	string	Der Nachname des Benutzers.
Email	templatesList.templateLastUpdatedBy.emailId	string	Die E-Mail-Adresse des Benutzers.

Abrufen von Webhook-Kanaldetails

Vorgangs-ID:: GetWebhookChannelDetails

Ruft die Details eines bestimmten Webhook-Kanals ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kanal-ID	channelId	True	string	Der eindeutige Bezeichner des abzurufenden Webhook-Kanals.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
ID	channel.channelId	integer	Der eindeutige Bezeichner des Webhook-Kanals.
Unternehmens-ID	channel.companyId	integer	Das Firmenkonto, zu dem dieser Kanal gehört.
Name	channel.channelName	string	Der Name des Webhook-Kanals.
Webhook-URL	channel.webhookUrl	string	Die URL, die Foxit eSign aufruft, wenn ein abonniertes Ereignis auftritt.
Geheimer Webhook-Schlüssel	channel.webhookSecret	string	Der geheime Schlüssel, der zum Überprüfen von Webhook-Nutzlasten verwendet wird.
Erstellt am	channel.dateCreated	integer	Das Datum, an dem der Kanal erstellt wurde, in Unix Millisekunden.
Datum aktualisiert	channel.dateUpdated	integer	Das Datum, an dem der Kanal zuletzt aktualisiert wurde, in Unix Millisekunden.
Webhook-Ebene	channel.webhookLevel	string	Der Bereich des Webhook-Kanals. Entweder "Konto" (Trigger für alle Umschläge) oder "API-App" (Trigger nur für Überschläge, die über die API erstellt wurden).
Status	channel.status	string	Der aktuelle Status des Kanals. Entweder "aktiv" oder "deaktiv".
Briefumschlag gesendet	channel.eventsSubscribedMap.folder_sent	boolean	Wird ausgelöst, wenn ein Umschlag an Empfänger gesendet wird.
Umschlag angezeigt	channel.eventsSubscribedMap.folder_viewed	boolean	Löst aus, wenn ein Umschlag von einem Empfänger geöffnet wird.
Umschlag signiert	channel.eventsSubscribedMap.folder_signed	boolean	Wird ausgelöst, wenn ein Umschlag von einem Empfänger signiert wird.
Umschlag abgebrochen	channel.eventsSubscribedMap.folder_cancelled	boolean	Löst aus, wenn ein Umschlag abgebrochen wird.
Umschlag ausgeführt	channel.eventsSubscribedMap.folder_executed	boolean	Wird ausgelöst, wenn alle Parteien unterzeichnet haben und der Umschlag vollständig ausgeführt wird.
Umschlag gelöscht	channel.eventsSubscribedMap.folder_deleted	boolean	Löst aus, wenn ein Umschlag gelöscht wird.

Alle Webhook-Kanäle auflisten

Vorgangs-ID:: ListallWebhookChannels

Gibt eine Liste aller webhook-Kanäle zurück, die in Ihrem Konto konfiguriert sind.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
Gesamtkanäle	total_channel	integer	Die Gesamtzahl der im Konto konfigurierten Webhook-Kanäle.
Webhook-Kanäle	templatesList	array of object	Die Liste aller Webhook-Kanäle im Konto.
Kanal-ID	templatesList.channelId	integer	Der eindeutige Bezeichner des Webhook-Kanals.
Unternehmens-ID	templatesList.companyId	integer	Das Firmenkonto, zu dem dieser Kanal gehört.
Kanalname	templatesList.channelName	string	Der Name des Webhook-Kanals.
Webhook-URL	templatesList.webhookUrl	string	Die URL, die Foxit eSign aufruft, wenn ein abonniertes Ereignis auftritt.
Geheimer Webhook-Schlüssel	templatesList.webhookSecret	string	Der geheime Schlüssel, der zum Überprüfen von Webhook-Nutzlasten verwendet wird.
Erstellt am	templatesList.dateCreated	integer	Das Datum, an dem der Kanal erstellt wurde, in Unix Millisekunden.
Datum aktualisiert	templatesList.dateUpdated	integer	Das Datum, an dem der Kanal zuletzt aktualisiert wurde, in Unix Millisekunden.
Webhook-Ebene	templatesList.webhookLevel	string	Der Bereich des Webhook-Kanals. Entweder "Konto" (Trigger für alle Umschläge) oder "API-App" (Trigger nur für Überschläge, die über die API erstellt wurden).
Status	templatesList.status	string	Der aktuelle Status des Kanals. Entweder "aktiv" oder "deaktiv".
Briefumschlag gesendet	templatesList.eventsSubscribedMap.folder_sent	boolean	Wird ausgelöst, wenn ein Umschlag an Empfänger gesendet wird.
Umschlag angezeigt	templatesList.eventsSubscribedMap.folder_viewed	boolean	Löst aus, wenn ein Umschlag von einem Empfänger geöffnet wird.
Umschlag signiert	templatesList.eventsSubscribedMap.folder_signed	boolean	Wird ausgelöst, wenn ein Umschlag von einem Empfänger signiert wird.
Umschlag abgebrochen	templatesList.eventsSubscribedMap.folder_cancelled	boolean	Löst aus, wenn ein Umschlag abgebrochen wird.
Umschlag ausgeführt	templatesList.eventsSubscribedMap.folder_executed	boolean	Wird ausgelöst, wenn alle Parteien unterzeichnet haben und der Umschlag vollständig ausgeführt wird.
Umschlag gelöscht	templatesList.eventsSubscribedMap.folder_deleted	boolean	Löst aus, wenn ein Umschlag gelöscht wird.

Bericht herunterladen

Vorgangs-ID:: DownloadReport

Lädt einen Umschlagaktivitätsbericht als Microsoft Excel Datei herunter. Verwenden Sie die Filter, um Ergebnisse nach Status, Datumsbereich, Umschlagname, Autor oder Signierer einzugrenzen.

Parameter

Name	Schlüssel	Typ	Beschreibung
envelopeStatus	status	string	Die Status des Ordners, nach dem ein Bericht gefiltert wird
Erstellungsdatum von	creationDateFrom	string	Anfang des Erstellungsdatumsbereichs. Akzeptiertes Format: JJJJ-MM-TT.
Erstellungsdatum bis	creationDateTo	string	Ende des Erstellungsdatumsbereichs. Akzeptiertes Format: JJJJ-MM-TT.
Umschlagname	folderName	string	Jeder Ordner, der diese Zeichenfolge enthält.
Einschließen von Feldern	includeFields	string	Legen Sie den Wert auf "true" fest, um Umschlagfeldwerte in den Bericht einzuschließen. Der Standardwert ist "false".
Email erstellen	authorEmail	string	Filtern Sie den Bericht so, dass nur Umschläge enthalten sind, die von dieser Autor-E-Mail-Adresse erstellt wurden.
Signierer-E-Mail	signerEmail	string	Filtern Sie den Bericht so, dass nur Umschläge enthalten sind, bei denen es sich bei dieser E-Mail-Adresse um einen Signierer handelt.

Gibt zurück

Berichtsdatei: binary

Briefumschlag aus Base64 erstellen

Vorgangs-ID:: CreateEnvelopefromBase64

Erstellt und sendet einen Umschlag mit einem Base64-codierten PDF-Dokument.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschlagname	folderName	True	string	Der Name dieses Umschlags.
Eingabetyp	inputType		string	Eingabetyp für Dokumentquelle. Für diese Aktion wurde base64 behoben.
Base64-Dateizeichenfolgen	base64FileString	True	array of string	Ein Array von base64-codierten PDF-Dokumenten, die gesendet werden sollen.
Dateinamen	fileNames	True	array of string	Ein Array von Anzeigenamen für jedes Dokument in der gleichen Reihenfolge wie das Base64 File String-Array.
Vorname	firstName	True	string	Der Vorname des Empfängers.
Nachname	lastName	True	string	Der Nachname des Empfängers.
Email Adresse	emailId	True	string	Die E-Mail-Adresse des Empfängers.
permissions	permission	True	string
Sequenz	sequence	True	integer	Verwenden Sie dieses Feld, um einem Empfänger in der Liste der Empfängerparteien eine Sequenznummer zuzuweisen. Verwenden Sie eindeutige Sequenznummern für jede Partei ab 1 wie 1,2,3,4.... Wenn eine einzelne Person mehrmals im Signaturworkflow angezeigt wird, weisen Sie bei jeder Wiederholung des Empfängers eine andere Sequenz zu.
signerAuthLevels	signerAuthLevel		string	Die Authentifizierungsebene, die ein Signierer für Überprüfungszwecke nutzt
Ist Platzhalter	isPlaceholder		boolean	Verwenden Sie dieses Feld, um die Partei zu initiieren, ein Platzhalter. Hinweis: 1. firstName, lastName, emailId parameter's value must be blank of this party. 2. Um den Platzhalter hinzuzufügen, muss ein Empfänger mit der Berechtigung "PARTY_ASSIGNER" neuquiert werden.
Empfängerrolle	partyRole		string	Verwenden Sie dieses Feld, um eine Rolle des Platzhalters zuzuweisen.
Namensänderung zulassen	allowNameChange		string	Der Wert kann entweder "true" oder "false" lauten. Verwenden Sie diesen Parameter, um zuzulassen, dass der Signierer vor abschluss des Signiervorgangs vornamens und nachname aktualisiert werden kann.
Workflowsequenz	workflowSequence		integer	Weisen Sie diesem Empfänger eine Workflowsequenznummer zu. Wenn die Anmeldesequenz aktiviert ist, erhalten die Empfänger ihre Anmeldeaufladung in aufsteigender Reihenfolge.
Host-E-Mail-ID	hostEmailId		string	E-Mail-Adresse des In-Person Administrators.
Zugangscode	userDefinedAccessCode		string	Der Parameter enthält Access Code, wenn der Wert "signerAuthLevel" für die Authentifizierung als "Benutzerdefinierter Zugriffscode" festgelegt wird. Hinweis: 1. Bei Codes wird die Groß-/Kleinschreibung nicht beachtet. 2. Das System sendet diesen Code nicht, sodass Sie diesen Code direkt für den Signierer freigeben müssen. 3. Access-Code kann Alphabete, Zahlen und die folgenden Sonderzeichen enthalten: @,&,{,},%,(,),~,\|,!,+,^.
Partei ist E-Mail-Gruppe	partyIsEmailGroup		boolean	Verwenden Sie diesen Parameter beim Erstellen einer Party als Massenvorgang. Hinweis: Wenn dieser Parameter "true" lautet, werden "firstName", "lastName" und "emailId" dieser Partei ignoriert.
E-Mail-Gruppen-ID	emailGroupId		integer	Übergeben Sie die E-Mail an die Gruppen-ID, die Sie zum Erstellen eines Massenvorgangs verwenden möchten.
Massenhinzufügen von Single Signer	allowSingleSignerInBulk		boolean	Verwenden Sie diesen Parameter, um nur einer Person die Anmeldung in einer E-Mail-Gruppe zu gestatten.
Wählcode	dialingCode		string	Verwenden Sie dieses Feld, um einem Empfänger in der Liste der Empfängerparteien eine Länder-Einwahlcodes zuzuweisen.
Handynummer	mobileNumber		string	Verwenden Sie dieses Feld, um einem Empfänger in der Liste der Empfängerparteien eine Mobiltelefonnummer zuzuweisen.
Felder	Fields		object
Jetzt senden	sendNow		boolean	Wenn diese Option aktiviert ist, sendet Foxit eSign sofort einen eindeutigen Signaturlink an die E-Mail-Adresse jedes Empfängers. Deaktivieren Sie diese Option, um den Umschlag stattdessen als Entwurf zu speichern.
Erstellen einer eingebetteten Signatursitzung	createEmbeddedSigningSession	True	boolean	Das Signieren des Sitzungstokens wird generiert, ohne E-Mails an die Empfänger zu senden.
Erstellen einer eingebetteten Signatursitzung für alle Parteien	createEmbeddedSigningSessionForAllParties		boolean	Bei Festlegung auf "true" wird für jeden Empfänger im Umschlag eine eingebettete Signatur-URL generiert.
Verarbeiten von Texttags	processTextTags	True	boolean	Der Wert kann entweder wahr oder falsch sein. Dieses Feld wird verwendet, um zu bestimmen, ob Foxit eSign die Dokumente für Texttags analysieren soll, um sie in Foxit eSign-Felder zu konvertieren.
Prozess-Akrofelder	processAcroFields	True	boolean	Dieses Feld wird verwendet, um zu bestimmen, ob Foxit eSign die Dokumente für AcroFields analysieren soll, um sie in Foxit eSign-Felder zu konvertieren.
Anmeldesequenz	signInSequence		boolean	Dieses Feld wird verwendet, um zu bestimmen, ob Empfänger die Umschlagdokumente in einer Sequenz signieren. Wenn "false" lautet, erhalten alle Empfänger gleichzeitig eine Einladungs-E-Mail. Wenn "true" ist, erhält jeder Empfänger eine Einladungs-E-Mail nacheinander, nachdem der vorherige Empfänger die erforderliche Aufgabe abgeschlossen hat, z. B. das Signieren der Dokumente oder das Ausfüllen von Feldern usw.
"Persönlich aktivieren"	inPersonEnable		boolean	Dieses Feld wird verwendet, um den persönlichen Signierungsprozess zu initiieren, der auf jedem Gerät in wenigen Minuten problemlos abgeschlossen werden kann und E-Mail-basierte Signaturen bei Bedarf vermeidet. Wenn "false" lautet, erhalten alle Empfänger gleichzeitig die Einladungs-E-Mail. Wenn true, erhält der persönliche Administrator eine Einladungs-E-Mail, um den Signiervorgang für den Signierer zu initiieren.
Beheben von Empfängerparteien	fixRecipientParties		boolean	Wenn wahr, kann die Parteien in der eingebetteten Sendeansicht nicht für den Umschlag geändert werden, der bereits als Teil dieser Anforderung hinzugefügt wurde.
Dokumente korrigieren	fixDocuments		boolean	Wenn true, kann das eingebettete Senden die Dokumente für den Umschlag, die bereits als Teil dieser Anforderung hinzugefügt wurden, nicht ändern.
Erfolgs-URL senden	sendSuccessUrl		string	Geben Sie die absolute URL für die Zielseite ein, zu der der Signierer nach dem erfolgreichen Senden des Ordners in der eingebetteten Sendeansicht umgeleitet wird.
Url des Sendefehlers	sendErrorUrl		string	Geben Sie die absolute URL für die Zielseite ein, zu der der Signierer umgeleitet wird, wenn beim Senden des Ordners in der eingebetteten Sendeansicht ein Fehler auftritt.
Eingebettete Sendesitzung erstellen	createEmbeddedSendingSession		boolean	Wenn dieser Wert auf "true" festgelegt ist, wird ein eingebettetes Token generiert, um die Dokumentvorbereitungsansicht von Foxit eSign zu öffnen.
Eingebettete Signierer-E-Mail-IDs	embeddedSignersEmailIds		array of string	Ein Array von E-Mail-IDs von Empfängern, für die eine eingebettete Signatursitzung erstellt werden muss. Die E-Mail-IDs der Empfängerparteien, die in der Liste der Parteien hinzugefügt wurden.
Signiererfolgs-URL	signSuccessUrl		string	Geben Sie die absolute URL für die Signierer ein, die nach der erfolgreichen Anmeldung in der eingebetteten Signaturansicht umgeleitet werden.
Url zum Ablehnen von Signieren	signDeclineUrl		string	Geben Sie die absolute URL für die Signierer ein, an die umgeleitet werden soll, wenn die Anmeldung in der eingebetteten Signaturansicht abgelehnt wird.
Sign Later Url	signLaterUrl		string	Geben Sie die absolute URL für die Signierer ein, die weitergeleitet werden sollen, wenn Sie sich später in der eingebetteten Signaturansicht anmelden möchten.
Url des Signierfehlers	signErrorUrl		string	Geben Sie die absolute URL für die Signierer ein, die beim Signieren des Dokuments in der eingebetteten Signaturansicht zu einem Fehler weitergeleitet werden.
Jetzt senden und eingebettete Signatursitzung zulassen	allowSendNowAndEmbeddedSigningSession		boolean	Wenn "true" festgelegt ist, sendet Foxit eSign einen eindeutigen Signaturlink an jeden Empfänger. Dies gilt NUR, wenn parameter sendNow und createEmbeddedSigningSession true ist.
Erweiterte E-Mail-Überprüfung	allowAdvancedEmailValidation		boolean	Überprüfen Sie die E-Mail-Adresse der Parteien, wenn sie auf "true" festgelegt ist.
Signieren der Erfolgs-URL für alle Parteien	signSuccessUrlAllParties		boolean	Wenn "true" festgelegt ist, wird der Signierer nach der erfolgreichen Signierung an die url umgeleitet, die im SignSuccessUrl bereitgestellt wird. Dies gilt nur, wenn "sendNow" wahr ist.
E-Mail-Vorlagen-ID	emailTemplateId		integer	Übergeben Sie die E-Mail-Vorlagen-ID, um die anderen E-Mail-Vorlagen als Standard-E-Mail-Vorlagen zu senden.
Signierer-Anweisungs-ID	signerInstructionId		integer	Übergeben Sie die Anweisungs-ID, um andere Anmeldeanweisungen als die Standard-Signiereranweisungen zu senden.
Bestätigungsanweisungs-ID	confirmationInstructionId		string	Übergeben Sie die Bestätigungsanweisungs-ID, um andere Bestätigungsanweisungen als die Standardbestätigungsanweisungen zu senden.
Designfarbe	themeColor		string	Geben Sie den CSS-Wert ein, um die Designfarbe festzulegen.
Sitzung läuft ab	sessionExpire		boolean	Legen Sie "true" fest, um das Ablaufen der eingebetteten Signatursitzung zu initiieren.
Ablaufdatum	expiry		integer	Erforderlich, wenn sessionExpire "true" ist. Geben Sie die Dauer in Millisekunden des Ablaufs für die eingebettete Signatursitzung ein.
Abhängiger Feldname	dependentFieldName	True	string	Der Name des Felds, dessen Sichtbarkeit durch das übergeordnete Feld gesteuert wird.
Name des übergeordneten Felds	parentFieldName	True	string	Der Name des übergeordneten Felds, dessen Wert die Sichtbarkeit des abhängigen Felds steuert. Unterstützte übergeordnete Feldtypen: Textfeld, Textfeld, Kontrollkästchen, Optionsfeld, Dropdown.
Übergeordneter Feldwert	parentFieldValue	True	string	Der Wert des übergeordneten Felds, das das abhängige Feld auslöst, um sichtbar zu werden. Verwenden Sie für Kontrollkästchen- und Optionsfeldfelder aktiviert oder deaktiviert.
Options	options	True	string	Zusätzliche Abgleichsoptionen für textbasierte übergeordnete Felder. Akzeptierte Werte: isblank, allowNull, enthält.
Metadaten	metadata		object	Dies sollte im Schlüsselwertpaar enthalten sein. Maximal 1000 Schlüsselwertpaare sind zulässig.
Absender-E-Mail	senderEmail		string	Geben Sie E-Mails eines anderen Benutzers in Ihrem Konto ein, der zum Senden dieses Dokuments an die Empfängerparteien verwendet wird.
Schaltfläche "Hinzufügen" ausblenden	hideAddMeButton		boolean	Wenn true, blendet es die Schaltfläche "Ich hinzufügen" auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Schaltfläche "Neue Hinzufügen" ausblenden	hideAddNewButton		boolean	Wenn true, blendet es die Schaltfläche "Neu hinzufügen" auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Schaltfläche "Gruppe hinzufügen" ausblenden	hideAddGroupButton		boolean	Wenn true, blendet es die Schaltfläche "Gruppe hinzufügen" auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Feldname für Empfänger ausblenden	hideFieldNameForRecipients		boolean	Feldnamen für Empfänger für Dateneingabefelder und erweiterte Felder ausblenden. (Außer Optionsfeld, Kontrollkästchen, Bild und Link).
Kontrollkästchenrahmen ausblenden	hideCheckboxBorder		boolean	Rahmen des Kontrollkästchens werden in den ausgeführten Dokumenten ausgeblendet.
Auswahloption "Signierer ausblenden"	hideSignerSelectOption		boolean	Wenn true, blendet es das Eingabefeld "Vorhandener Signierername/E-Mail" für Empfängerparteien in einer eingebetteten Sendesitzung aus.
Signieraktionen ausblenden	hideSignerActions		boolean	Wenn true, blendet es die Signiereraktionen "bearbeiten", "ändern" und "entfernen" für Empfängerparteien in einer eingebetteten Sendesitzung aus.
Absendername ausblenden	hideSenderName		boolean	Wenn true, blendet es den Namen des Absenders auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Ordnername ausblenden	hideFolderName		boolean	Wenn true, blendet es den Ordnernamen in beiden eingebetteten Sitzungen aus.
Dokumentname ausblenden	hideDocumentsName		boolean	Wenn true, blendet es den Dokumentnamen in beiden eingebetteten Sitzungen aus.
Ablehnen zum Signieren ausblenden	hideDeclineToSign		boolean	Wenn true, blendet es die Option "Ablehnen zum Signieren" für den Signierer aus.
Weitere Aktion ausblenden	hideMoreAction		boolean	Wenn true, wird die Schaltfläche "Weitere Aktionen" beim Senden/Signieren der Sitzung ausgeblendet. Im Falle von "Jetzt senden": true, wird nichts ausgeblendet.
Schaltfläche "Senden" ausblenden	hideSendButton		boolean	Wenn true, wird die Schaltfläche "Senden" in der eingebetteten Sendesitzung ausgeblendet.
Next Required Fieldbtn ausblenden	hideNextRequiredFieldbtn		boolean	Wenn dieser Wert auf "true" festgelegt ist, blendet die Navigationsschaltfläche aus, die Signierer in das nächste erforderliche Feld verschiebt.
Erforderliche eingebettete Sitzung	requiredBothEmbeddedSession		boolean	Wenn true, generiert sie die eingebetteten Sende- und Signatur-URLs zusammen.
Briefumschlagkennwort	folderPassword		string	Dieses Kennwort wird vom Signierer/Autor benötigt, um das digital signierte Dokument zu öffnen. Wenn der Parameter leer gehalten wird, ist kein Kennwort erforderlich, um das digital signierte Dokument zu öffnen.
Schritt für Schritt aktivieren	enableStepByStep		boolean	So aktivieren Sie schritt-für-Schritt-Aktion in der eingebetteten Sendesitzung.
Option "Parteien hinzufügen" ausblenden	hideAddPartiesOption		boolean	Wenn true, blendet es die Option zum Hinzufügen von Parteien im Entwurfs- und Vorlagenerstellungsmodus aus.
Selbstzeichen	selfSign		boolean	Es ermöglicht eingebettetes Self Sign über APIs. Dieser Parameter gilt nur, wenn der parameter createEmbeddedSendingSession true ist.
Self Signer Success Url	selfSignerSuccessUrl		string	Geben Sie die absolute URL für die Zielseite auf Ihrer Website/Anwendung ein, zu der der Benutzer nach dem erfolgreichen Senden des Ordners in der eingebetteten Sendeansicht umgeleitet wird.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	folder.folderId	integer	Die eindeutige ID des neu erstellten Umschlags. Verwenden Sie dies in nachfolgenden Aktionen, um auf diesen Umschlag zu verweisen.
Name	folder.folderName	string	Der Name des neu erstellten Umschlags.
Benutzerdefinierter Name	folder.folderCustomName	string	Ein benutzerdefinierter Name für den Umschlag.
Password	folder.folderPassword	string	Das Zugriffskennwort für den Umschlag, falls festgelegt.
Ersteller-ID	folder.folderAuthorId	integer	Der eindeutige Bezeichner des Umschlagerstellers.
Creator Vorname	folder.folderAuthorFirstName	string	Der Vorname des Briefumschlagerstellers.
Creator-Nachname	folder.folderAuthorLastName	string	Der Nachname des Briefumschlagerstellers.
Creator-E-Mail	folder.folderAuthorEmail	string	Die E-Mail-Adresse des Briefumschlagerstellers.
Erstellerrolle	folder.folderAuthorRole	string	Die Rolle des Briefumschlagerstellers.
Unternehmens-ID	folder.folderCompanyId	integer	Der eindeutige Bezeichner des Unternehmens, das den Umschlag besitzt.
Erstellungsdatum	folder.folderCreationDate	integer	Das Datum, an dem der Umschlag erstellt wurde (Unix-Zeitstempel in Millisekunden).
Sendedatum	folder.folderSentDate	integer	Das Datum, an dem der Umschlag gesendet wurde (Unix-Zeitstempel in Millisekunden).
Status	folder.folderStatus	string	Der aktuelle Status des Umschlags.
Benutzerdefiniertes Feld 1	folder.custom_field1	string	Das erste benutzerdefinierte Metadatenfeld für den Umschlag.
Benutzerdefiniertes Feld 2	folder.custom_field2	string	Das zweite benutzerdefinierte Metadatenfeld für den Umschlag.
Metadaten	folder.metadata	string	Benutzerdefinierte Metadaten, die dem Umschlag zugeordnet sind.
Dokument-IDs	folder.folderDocumentIds	array of integer	Die Liste der Dokument-IDs, die im Umschlag enthalten sind.
Dokumente	folder.documentsList	array of object	Die Liste der Dokumente im Umschlag.
Dokument-ID	folder.documentsList.documentId	integer	Der eindeutige Bezeichner des Dokuments.
Vertrags-ID	folder.documentsList.contractId	integer	Der eindeutige Bezeichner des Vertrags.
Unternehmens-ID	folder.documentsList.companyId	integer	Der eindeutige Bezeichner des Unternehmens.
Erstellt von	folder.documentsList.contractCreatedBy	integer	Die Benutzer-ID der Person, die den Vertrag erstellt hat.
Erstellt am	folder.documentsList.contractCreatedOn	string	Das Datum und die Uhrzeit, zu dem der Vertrag erstellt wurde.
Vertragsart	folder.documentsList.contractType	string	Der Vertragstyp.
Vertragsstatus	folder.documentsList.contractStatus	string	Der aktuelle Status des Vertrags.
Bearbeitbar	folder.documentsList.editable	boolean	Gibt an, ob das Element bearbeitet werden kann.
Versions-ID	folder.documentsList.contractVersionId	integer	Der eindeutige Bezeichner der Vertragsversion.
Versionsname	folder.documentsList.contractVersionName	string	Der Name der Vertragsversion.
Versionsbeschreibung	folder.documentsList.contractVersionDesc	string	Eine Beschreibung der Vertragsversion.
Version erstellt von	folder.documentsList.versionCreatedby	integer	Die Benutzer-ID der Person, die diese Version erstellt hat.
Version erstellt am	folder.documentsList.versionCreatedOn	string	Das Datum und die Uhrzeit der Erstellung dieser Version.
Versionsnummer	folder.documentsList.contractVersionNumber	integer	Die Versionsnummer des Vertrags.
Transaktionsquelle	folder.documentsList.contractTransactionSource	string	Das Quellsystem, das die Vertragstransaktion initiiert hat.
Empfänger	folder.folderRecipientParties	array of object	Die Liste der Empfängerparteien für diesen Umschlag.
Empfänger-ID	folder.folderRecipientParties.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Empfänger-ID	folder.folderRecipientParties.partyDetails.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Vorname	folder.folderRecipientParties.partyDetails.firstName	string	Der Vorname des Empfängers.
Nachname	folder.folderRecipientParties.partyDetails.lastName	string	Der Nachname des Empfängers.
Email Adresse	folder.folderRecipientParties.partyDetails.emailId	string	Die E-Mail-Adresse des Empfängers.
Platzhalter	folder.folderRecipientParties.partyDetails.placeholder	boolean	Gibt an, ob es sich bei dieser Partei um einen Platzhalterempfänger handelt.
Adresse	folder.folderRecipientParties.partyDetails.address	string	Die physische Adresse des Empfängers.
Erstellt am	folder.folderRecipientParties.partyDetails.dateCreated	integer	Das Datum, an dem der Datensatz erstellt wurde (Unix-Zeitstempel in Millisekunden).
Abmelden von E-Mails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Gibt an, ob der Empfänger E-Mail-Benachrichtigungen deaktiviert hat.
Eindeutige Empfänger-ID	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Ein eindeutiger Systembezeichner für diesen Empfänger.
Authentifizierungsebene	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Die für diesen Empfänger erforderliche Authentifizierungsmethode.
Kennwort aktualisiert am	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Das Datum, an dem das Kennwort zuletzt aktualisiert wurde.
Status des Kennworts aktualisiert	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Gibt an, ob das Kennwort aktualisiert wurde.
Unternehmens-ID	folder.folderRecipientParties.partyDetails.companyId	integer	Der eindeutige Bezeichner des Unternehmens.
Benutzerrolle	folder.folderRecipientParties.partyDetails.userRole	string	Die dem Benutzer zugewiesene Rolle.
Abteilung	folder.folderRecipientParties.partyDetails.department	string	Die Abteilung, zu der der Benutzer gehört.
Title	folder.folderRecipientParties.partyDetails.title	string	Die Position des Benutzers.
Aktiv	folder.folderRecipientParties.partyDetails.active	boolean	Gibt an, ob der Benutzer oder Datensatz aktiv ist.
Gebietsschema	folder.folderRecipientParties.partyDetails.requestLocale	string	Die Gebietsschemaeinstellung für den Benutzer.
Mit Dept teilen	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Gibt an, ob Umschläge für die gesamte Abteilung freigegeben werden.
Wählcode	folder.folderRecipientParties.partyDetails.dialingCode	string	Die internationale Wählnummer für die Telefonnummer.
Handynummer	folder.folderRecipientParties.partyDetails.mobileNumber	string	Die Mobiltelefonnummer.
Statusfilter	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Ein Filter für den Dokumentstatus.
Datumsfilter	folder.folderRecipientParties.partyDetails.docDateFilter	string	Ein Filter für das Dokumentdatum.
Sicherer Feldzugriff	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Gibt an, ob der Benutzer Zugriff auf sichere Felder hat.
Randleiste erweitern	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Gibt an, ob die Randleiste standardmäßig erweitert wird.
Adv. E-Mail-Überprüfung	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Gibt an, ob die erweiterte E-Mail-Überprüfung aktiviert ist.
Manager-ID	folder.folderRecipientParties.partyDetails.managerId	string	Der eindeutige Bezeichner des Vorgesetzten des Benutzers.
Anmeldeanzahl	folder.folderRecipientParties.partyDetails.loginCount	integer	Die Anzahl der Anmeldungen des Benutzers.
E-Mail-Kennwortzurücksetzung	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Gibt an, ob eine E-Mail zur Kennwortzurücksetzung gesendet werden soll.
Abteilungs-ID	folder.folderRecipientParties.partyDetails.departmentId	string	Der eindeutige Bezeichner der Abteilung.
Primäres Unternehmen	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Das primäre Unternehmen, das dem Benutzer zugeordnet ist.
Gerätetyp	folder.folderRecipientParties.partyDetails.deviceType	string	Der Typ des verwendeten Geräts.
Gerätetoken	folder.folderRecipientParties.partyDetails.deviceToken	string	Das Pushbenachrichtigungstoken für das Gerät.
Subunternehmerbeschreibung	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Eine Beschreibung des Subunternehmers oder des externen Signierers.
Subunternehmerorganisation	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Der Name der Organisation des Subunternehmers oder des externen Signierers.
Hinzugefügter Subunternehmerdatum	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Das Datum, an dem der Subunternehmer hinzugefügt wurde (Unix-Zeitstempel in Millisekunden).
Grundlage	folder.folderRecipientParties.partyDetails.source	string	Das Quellsystem, aus dem der externe Signierer hinzugefügt wurde.
Wählcode	folder.folderRecipientParties.dialingCode	string	Die internationale Wählnummer für die Telefonnummer.
Handynummer	folder.folderRecipientParties.mobileNumber	string	Die Mobiltelefonnummer.
Signaturtyp	folder.folderRecipientParties.signerSignatureType	string	Der Signaturtyp, den der Signierer verwendet.
Erlaubnisse	folder.folderRecipientParties.contractPermissions	string	Die Berechtigungen, die dieser Partei für den Vertrag erteilt wurden.
Signierreihenfolge	folder.folderRecipientParties.partySequence	integer	Die Sequenznummer der Signierreihenfolge für diesen Empfänger.
Workflowsequenz	folder.folderRecipientParties.workflowSignSequence	integer	Die Nummer der Workflowsignatursequenz.
Umschlag-ID	folder.folderRecipientParties.envelopeId	integer	Der eindeutige Bezeichner des Umschlags.
Firmen-ID des Empfängers	folder.folderRecipientParties.partyCompanyId	integer	Der eindeutige Bezeichner des Unternehmens, das diesem Empfänger zugeordnet ist.
Freigabemodus	folder.folderRecipientParties.sharingMode	string	Der Freigabemodus für diesen Umschlag.
Empfängerzugriffs-URL	folder.folderRecipientParties.folderAccessURL	string	Die URL, die der Empfänger verwenden kann, um auf den Umschlag zuzugreifen und zu signieren.
Sicherheitsmodus	folder.folderRecipientParties.securityMode	string	Der auf diesen Umschlag angewendete Sicherheitsmodus.
Kommentare	folder.folderRecipientParties.extraComments	string	Zusätzliche Kommentare, die im Umschlag enthalten sind.
Namensänderung zulassen	folder.folderRecipientParties.allowNameChange	boolean	Gibt an, ob der Empfänger seinen Namen aktualisieren darf.
Name aktualisiert	folder.folderRecipientParties.signerNameUpdated	boolean	Gibt an, ob der Signierer seinen Namen aktualisiert hat.
Signierer-Authentifizierungsebene	folder.folderRecipientParties.signerAuthenticationLevel	string	Die für den Signierer erforderliche Authentifizierungsstufe.
Zugangscode	folder.folderRecipientParties.userDefinedAccessCode	string	Ein benutzerdefinierter Zugriffscode, der für den Signierer definiert ist.
Signatur-ID	folder.folderRecipientParties.signatureId	string	Der eindeutige Bezeichner der Signatur.
Empfängerrolle	folder.folderRecipientParties.partyRole	string	Die diesem Empfänger zugewiesene Rolle im Signaturworkflow.
Firmenfeld	folder.folderRecipientParties.companyFieldValue	string	Der Wert des Firmennamenfelds in der Signatur.
Titelfeld	folder.folderRecipientParties.titleFieldValue	string	Der Wert des Titelfelds in der Signatur.
Grund für die Signierung	folder.folderRecipientParties.reasonSigning	string	Der Grund, warum der Empfänger das Dokument signiert.
Zahlungsfeld hinzugefügt	folder.folderRecipientParties.payFieldAdded	boolean	Gibt an, ob ein Zahlungsfeld hinzugefügt wurde.
Zahlungsempfänger	folder.folderRecipientParties.payee	boolean	Gibt an, ob dieser Empfänger der Zahlungsempfänger ist.
Wiederkehrende Zahlung	folder.folderRecipientParties.recurringFieldExist	boolean	Gibt an, ob ein wiederkehrendes Zahlungsfeld vorhanden ist.
Drucken und Signieren fertig	folder.folderRecipientParties.printAndSignCompleted	boolean	Gibt an, ob der Druck- und Signiervorgang abgeschlossen ist.
Bezahlt	folder.folderRecipientParties.paid	boolean	Gibt an, ob die Zahlung abgeschlossen wurde.
Optionaler Signierer zulässig	folder.folderRecipientParties.allowOptionalSigner	boolean	Gibt an, ob dieser Empfänger ein optionaler Signierer ist.
Optionale Signierer	folder.folderRecipientParties.optionalSigners	array of integer	Die Liste der optionalen Anmeldeprogramm-IDs für diesen Umschlag.
Signatur-URL des Autors	folder.folderAccessURLForAuthor	string	Die URL, die der Absender für den Zugriff auf den Umschlag verwenden kann.
Url des Entwurfszugriffs	folder.draftFolderAccessURL	string	Die URL, die für den Zugriff auf die Entwurfsversion des Umschlags verwendet wird.
BoardroomSignatur	folder.boardRoomSign	boolean	Gibt an, ob der Boardroomsignierungsmodus aktiviert ist.
Logo einschließen	folder.includeLogo	boolean	Gibt an, ob das Firmenlogo in E-Mails enthalten ist.
Schaltflächenhintergrundfarbe	folder.email_btnBgColor	string	Die Hintergrundfarbe der Schaltfläche "E-Mail".
Schaltflächentextfarbe	folder.email_btnTxtColor	string	Die Textfarbe der Schaltfläche "E-Mail".
E-Mail-Logo	folder.emailTemplateLogo	string	Die in der E-Mail-Vorlage verwendete Logo-URL.
E-Mail-Vorlagen-ID	folder.emailTemplateId	integer	Der eindeutige Bezeichner der E-Mail-Vorlage.
E-Mail-Kopfzeile	folder.emailHeader	string	Der Kopfzeilentext, der in Benachrichtigungs-E-Mails verwendet wird.
E-Mail-Fußzeile	folder.emailFooter	string	Der Fußzeilentext, der in Benachrichtigungs-E-Mails verwendet wird.
Geplante Bereinigung	folder.purgeFlag	boolean	Gibt an, ob der Umschlag für die Bereinigung geplant ist.
Startdatum löschen	folder.purgeStartDate	string	Das Datum, ab dem die Bereinigung beginnen soll.
Enddatum löschen	folder.purgeEndDate	string	Das Datum, an dem die Bereinigung abgeschlossen werden soll.
Massensendungs-ID	folder.bulkId	integer	Der eindeutige Bezeichner des Massensendungsvorgangs.
Signierreihenfolge erzwingen	folder.enforceSignWorkflow	boolean	Gibt an, ob sich Empfänger bei der definierten Sequenz anmelden müssen.
Aktueller Schritt	folder.currentWorkflowStep	integer	Der aktuelle Schritt im Signaturworkflow.
Transaktionsquelle	folder.transactionSource	string	Das Quellsystem, das diese Transaktion initiiert hat.
Bearbeitbar	folder.editable	boolean	Gibt an, ob das Element bearbeitet werden kann.
In-Person Signierung	folder.inPersonSignable	boolean	Gibt an, ob der Umschlag persönlich angemeldet werden kann.
Überschreiben von Erinnerungen	folder.overrideAccountReminders	boolean	Gibt an, ob Erinnerungseinstellungen auf Kontoebene überschrieben werden.
Delegierung außer Kraft setzen	folder.overrideAccountRecipientDelegation	boolean	Gibt an, ob Delegierungseinstellungen auf Kontoebene überschrieben werden.
Delegierung zulassen	folder.allowRecipientsToDelegate	boolean	Gibt an, ob Empfänger die Signierung delegieren dürfen.
ID	folder.envelopeId	integer	Der eindeutige Bezeichner des Umschlags.
Name	folder.envelopeName	string	Der Name des Umschlags.
Absender-ID	folder.envelopeOriginatorId	integer	Der eindeutige Bezeichner des Benutzers, der den Umschlag erstellt hat.
Unternehmens-ID	folder.envelopeCompanyId	integer	Der eindeutige Bezeichner des Unternehmens, das den Umschlag besitzt.
Datum	folder.envelopeDate	integer	Das Datum, an dem der Umschlag erstellt wurde (Unix-Zeitstempel in Millisekunden).
Freigegebenes Datum	folder.envelopeSharedDate	integer	Das Datum, an dem der Umschlag geteilt wurde (Unix-Zeitstempel in Millisekunden).
Status	folder.envelopeStatus	string	Der aktuelle Status des Umschlags.
Vertrags-IDs	folder.envelopeContractIds	array of integer	Die Liste der Vertrags-IDs, die diesem Umschlag zugeordnet sind.
Empfängerberechtigungen	folder.envelopePartyPermissions	array of object	Die Liste der Empfängerberechtigungen für diesen Umschlag.
Empfänger-ID	folder.envelopePartyPermissions.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Empfänger-ID	folder.envelopePartyPermissions.partyDetails.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Vorname	folder.envelopePartyPermissions.partyDetails.firstName	string	Der Vorname des Empfängers.
Nachname	folder.envelopePartyPermissions.partyDetails.lastName	string	Der Nachname des Empfängers.
Email Adresse	folder.envelopePartyPermissions.partyDetails.emailId	string	Die E-Mail-Adresse des Empfängers.
Platzhalter	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Gibt an, ob es sich bei dieser Partei um einen Platzhalterempfänger handelt.
Adresse	folder.envelopePartyPermissions.partyDetails.address	string	Die physische Adresse des Empfängers.
Erstellt am	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Das Datum, an dem der Datensatz erstellt wurde (Unix-Zeitstempel in Millisekunden).
Abmelden von E-Mails	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Gibt an, ob der Empfänger E-Mail-Benachrichtigungen deaktiviert hat.
Eindeutige Empfänger-ID	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Ein eindeutiger Systembezeichner für diesen Empfänger.
Authentifizierungsebene	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Die für diesen Empfänger erforderliche Authentifizierungsmethode.
Kennwort aktualisiert am	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Das Datum, an dem das Kennwort zuletzt aktualisiert wurde.
Status des Kennworts aktualisiert	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Gibt an, ob das Kennwort aktualisiert wurde.
Unternehmens-ID	folder.envelopePartyPermissions.partyDetails.companyId	integer	Der eindeutige Bezeichner des Unternehmens.
Benutzerrolle	folder.envelopePartyPermissions.partyDetails.userRole	string	Die dem Benutzer zugewiesene Rolle.
Abteilung	folder.envelopePartyPermissions.partyDetails.department	string	Die Abteilung, zu der der Benutzer gehört.
Title	folder.envelopePartyPermissions.partyDetails.title	string	Die Position des Benutzers.
Aktiv	folder.envelopePartyPermissions.partyDetails.active	boolean	Gibt an, ob der Benutzer oder Datensatz aktiv ist.
Gebietsschema	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Die Gebietsschemaeinstellung für den Benutzer.
Mit Dept teilen	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Gibt an, ob Umschläge für die gesamte Abteilung freigegeben werden.
Wählcode	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Die internationale Wählnummer für die Telefonnummer.
Handynummer	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Die Mobiltelefonnummer.
Statusfilter	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Ein Filter für den Dokumentstatus.
Datumsfilter	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Ein Filter für das Dokumentdatum.
Sicherer Feldzugriff	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Gibt an, ob der Benutzer Zugriff auf sichere Felder hat.
Randleiste erweitern	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Gibt an, ob die Randleiste standardmäßig erweitert wird.
Adv. E-Mail-Überprüfung	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Gibt an, ob die erweiterte E-Mail-Überprüfung aktiviert ist.
Manager-ID	folder.envelopePartyPermissions.partyDetails.managerId	string	Der eindeutige Bezeichner des Vorgesetzten des Benutzers.
Anmeldeanzahl	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Die Anzahl der Anmeldungen des Benutzers.
E-Mail-Kennwortzurücksetzung	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Gibt an, ob eine E-Mail zur Kennwortzurücksetzung gesendet werden soll.
Abteilungs-ID	folder.envelopePartyPermissions.partyDetails.departmentId	string	Der eindeutige Bezeichner der Abteilung.
Primäres Unternehmen	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Das primäre Unternehmen, das dem Benutzer zugeordnet ist.
Gerätetyp	folder.envelopePartyPermissions.partyDetails.deviceType	string	Der Typ des verwendeten Geräts.
Gerätetoken	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Das Pushbenachrichtigungstoken für das Gerät.
Subunternehmerbeschreibung	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Eine Beschreibung des Subunternehmers oder des externen Signierers.
Subunternehmerorganisation	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Der Name der Organisation des Subunternehmers oder des externen Signierers.
Hinzugefügter Subunternehmerdatum	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Das Datum, an dem der Subunternehmer hinzugefügt wurde (Unix-Zeitstempel in Millisekunden).
Grundlage	folder.envelopePartyPermissions.partyDetails.source	string	Das Quellsystem, aus dem der externe Signierer hinzugefügt wurde.
Wählcode	folder.envelopePartyPermissions.dialingCode	string	Die internationale Wählnummer für die Telefonnummer.
Handynummer	folder.envelopePartyPermissions.mobileNumber	string	Die Mobiltelefonnummer.
Signaturtyp	folder.envelopePartyPermissions.signerSignatureType	string	Der Signaturtyp, den der Signierer verwendet.
Erlaubnisse	folder.envelopePartyPermissions.contractPermissions	string	Die Berechtigungen, die dieser Partei für den Vertrag erteilt wurden.
Signierreihenfolge	folder.envelopePartyPermissions.partySequence	integer	Die Sequenznummer der Signierreihenfolge für diesen Empfänger.
Workflowsequenz	folder.envelopePartyPermissions.workflowSignSequence	integer	Die Nummer der Workflowsignatursequenz.
Umschlag-ID	folder.envelopePartyPermissions.envelopeId	integer	Der eindeutige Bezeichner des Umschlags.
Firmen-ID des Empfängers	folder.envelopePartyPermissions.partyCompanyId	integer	Der eindeutige Bezeichner des Unternehmens, das diesem Empfänger zugeordnet ist.
Freigabemodus	folder.envelopePartyPermissions.sharingMode	string	Der Freigabemodus für diesen Umschlag.
Empfängerzugriffs-URL	folder.envelopePartyPermissions.folderAccessURL	string	Die URL, die der Empfänger verwenden kann, um auf den Umschlag zuzugreifen und zu signieren.
Sicherheitsmodus	folder.envelopePartyPermissions.securityMode	string	Der auf diesen Umschlag angewendete Sicherheitsmodus.
Kommentare	folder.envelopePartyPermissions.extraComments	string	Zusätzliche Kommentare, die im Umschlag enthalten sind.
Namensänderung zulassen	folder.envelopePartyPermissions.allowNameChange	boolean	Gibt an, ob der Empfänger seinen Namen aktualisieren darf.
Name aktualisiert	folder.envelopePartyPermissions.signerNameUpdated	boolean	Gibt an, ob der Signierer seinen Namen aktualisiert hat.
Signierer-Authentifizierungsebene	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Die für den Signierer erforderliche Authentifizierungsstufe.
Zugangscode	folder.envelopePartyPermissions.userDefinedAccessCode	string	Ein benutzerdefinierter Zugriffscode, der für den Signierer definiert ist.
Signatur-ID	folder.envelopePartyPermissions.signatureId	string	Der eindeutige Bezeichner der Signatur.
Empfängerrolle	folder.envelopePartyPermissions.partyRole	string	Die diesem Empfänger zugewiesene Rolle im Signaturworkflow.
Firmenfeld	folder.envelopePartyPermissions.companyFieldValue	string	Der Wert des Firmennamenfelds in der Signatur.
Titelfeld	folder.envelopePartyPermissions.titleFieldValue	string	Der Wert des Titelfelds in der Signatur.
Grund für die Signierung	folder.envelopePartyPermissions.reasonSigning	string	Der Grund, warum der Empfänger das Dokument signiert.
Zahlungsfeld hinzugefügt	folder.envelopePartyPermissions.payFieldAdded	boolean	Gibt an, ob ein Zahlungsfeld hinzugefügt wurde.
Zahlungsempfänger	folder.envelopePartyPermissions.payee	boolean	Gibt an, ob dieser Empfänger der Zahlungsempfänger ist.
Wiederkehrende Zahlung	folder.envelopePartyPermissions.recurringFieldExist	boolean	Gibt an, ob ein wiederkehrendes Zahlungsfeld vorhanden ist.
Drucken und Signieren fertig	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Gibt an, ob der Druck- und Signiervorgang abgeschlossen ist.
Bezahlt	folder.envelopePartyPermissions.paid	boolean	Gibt an, ob die Zahlung abgeschlossen wurde.
Authentifizierungsebene	folder.envelopeAuthenticationLevel	string	Die für den Umschlag erforderliche Authentifizierungsstufe.
Massenhinzufügen von Single Signer	folder.allowSingleSignerInBulk	boolean	Gibt an, ob ein Single Signer im Massensendungsmodus zulässig ist.
File-Based Benennung	folder.folderNameBasedOnFileNaming	boolean	Gibt an, ob der Ordnername auf dem Dateinamen basiert.
Doc File-Based Name	folder.documentNameBasedOnFileNaming	boolean	Gibt an, ob der Dokumentname auf dem Dateinamen basiert.
Name des Zertifikats File-Based	folder.certificateNameBasedOnFileNaming	boolean	Gibt an, ob der Zertifikatname auf dem Dateinamen basiert.
Prä-Exec-Dateibenennung	folder.enableFileNamingBeforeExecution	boolean	Gibt an, ob die Dateibenennung vor der Dokumentausführung aktiviert ist.
Payee hinzugefügt	folder.payeeAddedd	boolean	Gibt an, ob ein Zahlungsempfänger hinzugefügt wurde.
Self-Signing aktiviert	folder.selfSignerEnabled	boolean	Gibt an, ob der Selbstsignierungsmodus aktiviert ist.
Notar aktiviert	folder.notaryEnabled	boolean	Gibt an, ob die Notarsignierung aktiviert ist.
Eingeschränkte Sichtbarkeit	folder.limitedVisibilityFlag	boolean	Gibt an, ob die eingeschränkte Sichtbarkeit für diesen Umschlag aktiviert ist.
Sichtbarkeit nach dem Signieren	folder.postSigningVisibility	boolean	Gibt an, ob die Sichtbarkeit nach dem Signieren aktiviert ist.
Nasse Signatur	folder.wetSignatureEnabled	boolean	Gibt an, ob nasse Signaturen aktiviert sind.
Seriendruck aktiviert	folder.mergeEnabled	boolean	Gibt an, ob das Zusammenführen von Dokumenten aktiviert ist.
Eingebettete Signatursitzungen	embeddedSigningSessions	array of object	Die Liste der eingebetteten Signatursitzungen, eine pro Empfänger. Nur vorhanden, wenn createEmbeddedSigningSession true ist.
Signierer-E-Mail	embeddedSigningSessions.emailIdOfSigner	string	Die E-Mail-Adresse des Empfängers für diese eingebettete Signatursitzung.
Signaturtoken	embeddedSigningSessions.embeddedToken	string	Das eindeutige Token für die eingebettete Signatursitzung dieses Empfängers.
Signatursitzungs-URL	embeddedSigningSessions.embeddedSessionURL	string	Die URL, die für diesen Empfänger geöffnet oder eingebettet werden soll, um das Dokument zu signieren.
Eingebettetes Senden von Token	embeddedToken	string	Das Token für die eingebettete Sendesitzung. Nur vorhanden, wenn createEmbeddedSendingSession true ist.
Senden der Sitzungs-URL	embeddedSessionURL	string	Die URL zum Öffnen oder Einbetten des Umschlagautors, um den Umschlag vorzubereiten und zu senden. Nur vorhanden, wenn createEmbeddedSendingSession true ist.
Result	result	string	Das Ergebnis des Vorgangs.
Nachricht	message	string	Eine Meldung, die das Ergebnis des Vorgangs beschreibt.

Briefumschlag aus URL erstellen

Vorgangs-ID:: CreateEnvelopefromURL

Erstellt und sendet einen Umschlag mithilfe öffentlich zugänglicher PDF-URLs. Geben Sie die Dokument-URLs und Empfängerdetails an, um den Signiervorgang zu initiieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschlagname	folderName	True	string	Der Name dieses Umschlags.
Eingabetyp	inputType		string	Gibt das Dokumentquellformat an. Legen Sie die URL fest, um Datei-URLs oder Base64 bereitzustellen, um Base64-codierte Dateiinhalte bereitzustellen.
Datei-URLs	fileUrls	True	array of string	Ein Array von öffentlich zugänglichen URLs, die auf die Dokumente verweisen, die diesem Umschlag hinzugefügt werden sollen.
Dateinamen	fileNames	True	array of string	Ein Array von Anzeigenamen für jedes Dokument in der gleichen Reihenfolge wie Datei-URLs.
Vorname	firstName	True	string	Der Vorname des Empfängers.
Nachname	lastName	True	string	Der Nachname des Empfängers.
Email Adresse	emailId	True	string	Die E-Mail-Adresse des Empfängers.
permissions	permission	True	string
Sequenz	sequence	True	integer	Verwenden Sie dieses Feld, um einem Empfänger in der Liste der Empfängerparteien eine Sequenznummer zuzuweisen. Verwenden Sie eindeutige Sequenznummern für jede Partei ab 1 wie 1,2,3,4.... Wenn eine einzelne Person mehrmals im Signaturworkflow angezeigt wird, weisen Sie bei jeder Wiederholung des Empfängers eine andere Sequenz zu.
signerAuthLevels	signerAuthLevel		string	Die Authentifizierungsebene, die ein Signierer für Überprüfungszwecke nutzt
Ist Platzhalter	isPlaceholder		boolean	Verwenden Sie dieses Feld, um die Partei zu initiieren, ein Platzhalter. Hinweis: 1. firstName, lastName, emailId parameter's value must be blank of this party. 2. Um den Platzhalter hinzuzufügen, muss ein Empfänger mit der Berechtigung "PARTY_ASSIGNER" neuquiert werden.
Empfängerrolle	partyRole		string	Verwenden Sie dieses Feld, um eine Rolle des Platzhalters zuzuweisen.
Namensänderung zulassen	allowNameChange		string	Der Wert kann entweder "true" oder "false" lauten. Verwenden Sie diesen Parameter, um zuzulassen, dass der Signierer vor abschluss des Signiervorgangs vornamens und nachname aktualisiert werden kann.
Workflowsequenz	workflowSequence		integer	Weisen Sie diesem Empfänger eine Workflowsequenznummer zu. Wenn die Anmeldesequenz aktiviert ist, erhalten die Empfänger ihre Anmeldeaufladung in aufsteigender Reihenfolge.
Host-E-Mail-ID	hostEmailId		string	E-Mail-Adresse des In-Person Administrators.
Zugangscode	userDefinedAccessCode		string	Der Parameter enthält Access Code, wenn der Wert "signerAuthLevel" für die Authentifizierung als "Benutzerdefinierter Zugriffscode" festgelegt wird. Hinweis: 1. Bei Codes wird die Groß-/Kleinschreibung nicht beachtet. 2. Das System sendet diesen Code nicht, sodass Sie diesen Code direkt für den Signierer freigeben müssen. 3. Access-Code kann Alphabete, Zahlen und die folgenden Sonderzeichen enthalten: @,&,{,},%,(,),~,\|,!,+,^.
Partei ist E-Mail-Gruppe	partyIsEmailGroup		boolean	Verwenden Sie diesen Parameter beim Erstellen einer Party als Massenvorgang. Hinweis: Wenn dieser Parameter "true" lautet, werden "firstName", "lastName" und "emailId" dieser Partei ignoriert.
E-Mail-Gruppen-ID	emailGroupId		integer	Übergeben Sie die E-Mail an die Gruppen-ID, die Sie zum Erstellen eines Massenvorgangs verwenden möchten.
Massenhinzufügen von Single Signer	allowSingleSignerInBulk		boolean	Verwenden Sie diesen Parameter, um nur einer Person die Anmeldung in einer E-Mail-Gruppe zu gestatten.
Wählcode	dialingCode		string	Verwenden Sie dieses Feld, um einem Empfänger in der Liste der Empfängerparteien eine Länder-Einwahlcodes zuzuweisen.
Handynummer	mobileNumber		string	Verwenden Sie dieses Feld, um einem Empfänger in der Liste der Empfängerparteien eine Mobiltelefonnummer zuzuweisen.
Felder	Fields		object
Jetzt senden	sendNow		boolean	Wenn diese Option aktiviert ist, sendet Foxit eSign sofort einen eindeutigen Signaturlink an die E-Mail-Adresse jedes Empfängers. Deaktivieren Sie diese Option, um den Umschlag stattdessen als Entwurf zu speichern.
Erstellen einer eingebetteten Signatursitzung	createEmbeddedSigningSession	True	boolean	Das Signieren des Sitzungstokens wird generiert, ohne E-Mails an die Empfänger zu senden.
Erstellen einer eingebetteten Signatursitzung für alle Parteien	createEmbeddedSigningSessionForAllParties		boolean	Bei Festlegung auf "true" wird für jeden Empfänger im Umschlag eine eingebettete Signatur-URL generiert.
Verarbeiten von Texttags	processTextTags	True	boolean	Der Wert kann entweder wahr oder falsch sein. Dieses Feld wird verwendet, um zu bestimmen, ob Foxit eSign die Dokumente für Texttags analysieren soll, um sie in Foxit eSign-Felder zu konvertieren.
Prozess-Akrofelder	processAcroFields	True	boolean	Dieses Feld wird verwendet, um zu bestimmen, ob Foxit eSign die Dokumente für AcroFields analysieren soll, um sie in Foxit eSign-Felder zu konvertieren.
Anmeldesequenz	signInSequence		boolean	Dieses Feld wird verwendet, um zu bestimmen, ob Empfänger die Umschlagdokumente in einer Sequenz signieren. Wenn "false" lautet, erhalten alle Empfänger gleichzeitig eine Einladungs-E-Mail. Wenn "true" ist, erhält jeder Empfänger eine Einladungs-E-Mail nacheinander, nachdem der vorherige Empfänger die erforderliche Aufgabe abgeschlossen hat, z. B. das Signieren der Dokumente oder das Ausfüllen von Feldern usw.
"Persönlich aktivieren"	inPersonEnable		boolean	Dieses Feld wird verwendet, um den persönlichen Signierungsprozess zu initiieren, der auf jedem Gerät in wenigen Minuten problemlos abgeschlossen werden kann und E-Mail-basierte Signaturen bei Bedarf vermeidet. Wenn "false" lautet, erhalten alle Empfänger gleichzeitig die Einladungs-E-Mail. Wenn true, erhält der persönliche Administrator eine Einladungs-E-Mail, um den Signiervorgang für den Signierer zu initiieren.
Beheben von Empfängerparteien	fixRecipientParties		boolean	Wenn wahr, kann die Parteien in der eingebetteten Sendeansicht nicht für den Umschlag geändert werden, der bereits als Teil dieser Anforderung hinzugefügt wurde.
Dokumente korrigieren	fixDocuments		boolean	Wenn true, kann das eingebettete Senden die Dokumente für den Umschlag, die bereits als Teil dieser Anforderung hinzugefügt wurden, nicht ändern.
Erfolgs-URL senden	sendSuccessUrl		string	Geben Sie die absolute URL für die Zielseite ein, zu der der Signierer nach dem erfolgreichen Senden des Ordners in der eingebetteten Sendeansicht umgeleitet wird.
Url des Sendefehlers	sendErrorUrl		string	Geben Sie die absolute URL für die Zielseite ein, zu der der Signierer umgeleitet wird, wenn beim Senden des Ordners in der eingebetteten Sendeansicht ein Fehler auftritt.
Eingebettete Sendesitzung erstellen	createEmbeddedSendingSession		boolean	Wenn dieser Wert auf "true" festgelegt ist, wird ein eingebettetes Token generiert, um die Dokumentvorbereitungsansicht von Foxit eSign zu öffnen.
Eingebettete Signierer-E-Mail-IDs	embeddedSignersEmailIds		array of string	Ein Array von E-Mail-IDs von Empfängern, für die eine eingebettete Signatursitzung erstellt werden muss. Die E-Mail-IDs der Empfängerparteien, die in der Liste der Parteien hinzugefügt wurden.
Signiererfolgs-URL	signSuccessUrl		string	Geben Sie die absolute URL für die Signierer ein, die nach der erfolgreichen Anmeldung in der eingebetteten Signaturansicht umgeleitet werden.
Url zum Ablehnen von Signieren	signDeclineUrl		string	Geben Sie die absolute URL für die Signierer ein, an die umgeleitet werden soll, wenn die Anmeldung in der eingebetteten Signaturansicht abgelehnt wird.
Sign Later Url	signLaterUrl		string	Geben Sie die absolute URL für die Signierer ein, die weitergeleitet werden sollen, wenn Sie sich später in der eingebetteten Signaturansicht anmelden möchten.
Url des Signierfehlers	signErrorUrl		string	Geben Sie die absolute URL für die Signierer ein, die beim Signieren des Dokuments in der eingebetteten Signaturansicht zu einem Fehler weitergeleitet werden.
Jetzt senden und eingebettete Signatursitzung zulassen	allowSendNowAndEmbeddedSigningSession		boolean	Wenn "true" festgelegt ist, sendet Foxit eSign einen eindeutigen Signaturlink an jeden Empfänger. Dies gilt NUR, wenn parameter sendNow und createEmbeddedSigningSession true ist.
Erweiterte E-Mail-Überprüfung	allowAdvancedEmailValidation		boolean	Überprüfen Sie die E-Mail-Adresse der Parteien, wenn sie auf "true" festgelegt ist.
Signieren der Erfolgs-URL für alle Parteien	signSuccessUrlAllParties		boolean	Wenn "true" festgelegt ist, wird der Signierer nach der erfolgreichen Signierung an die url umgeleitet, die im SignSuccessUrl bereitgestellt wird. Dies gilt nur, wenn "sendNow" wahr ist.
E-Mail-Vorlagen-ID	emailTemplateId		integer	Übergeben Sie die E-Mail-Vorlagen-ID, um die anderen E-Mail-Vorlagen als Standard-E-Mail-Vorlagen zu senden.
Signierer-Anweisungs-ID	signerInstructionId		integer	Übergeben Sie die Anweisungs-ID, um andere Anmeldeanweisungen als die Standard-Signiereranweisungen zu senden.
Bestätigungsanweisungs-ID	confirmationInstructionId		string	Übergeben Sie die Bestätigungsanweisungs-ID, um andere Bestätigungsanweisungen als die Standardbestätigungsanweisungen zu senden.
Designfarbe	themeColor		string	Geben Sie den CSS-Wert ein, um die Designfarbe festzulegen.
Sitzung läuft ab	sessionExpire		boolean	Legen Sie "true" fest, um das Ablaufen der eingebetteten Signatursitzung zu initiieren.
Ablaufdatum	expiry		integer	Erforderlich, wenn sessionExpire "true" ist. Geben Sie die Dauer in Millisekunden des Ablaufs für die eingebettete Signatursitzung ein.
Abhängiger Feldname	dependentFieldName	True	string	Der Name des Felds, dessen Sichtbarkeit durch das übergeordnete Feld gesteuert wird.
Name des übergeordneten Felds	parentFieldName	True	string	Der Name des übergeordneten Felds, dessen Wert die Sichtbarkeit des abhängigen Felds steuert. Unterstützte übergeordnete Feldtypen: Textfeld, Textfeld, Kontrollkästchen, Optionsfeld, Dropdown.
Übergeordneter Feldwert	parentFieldValue	True	string	Der Wert des übergeordneten Felds, das das abhängige Feld auslöst, um sichtbar zu werden. Verwenden Sie für Kontrollkästchen- und Optionsfeldfelder aktiviert oder deaktiviert.
Options	options	True	string	Zusätzliche Abgleichsoptionen für textbasierte übergeordnete Felder. Akzeptierte Werte: isblank, allowNull, enthält.
Metadaten	metadata		object	Dies sollte im Schlüsselwertpaar enthalten sein. Maximal 1000 Schlüsselwertpaare sind zulässig.
Absender-E-Mail	senderEmail		string	Geben Sie E-Mails eines anderen Benutzers in Ihrem Konto ein, der zum Senden dieses Dokuments an die Empfängerparteien verwendet wird.
Schaltfläche "Hinzufügen" ausblenden	hideAddMeButton		boolean	Wenn true, blendet es die Schaltfläche "Ich hinzufügen" auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Schaltfläche "Neue Hinzufügen" ausblenden	hideAddNewButton		boolean	Wenn true, blendet es die Schaltfläche "Neu hinzufügen" auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Schaltfläche "Gruppe hinzufügen" ausblenden	hideAddGroupButton		boolean	Wenn true, blendet es die Schaltfläche "Gruppe hinzufügen" auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Feldname für Empfänger ausblenden	hideFieldNameForRecipients		boolean	Feldnamen für Empfänger für Dateneingabefelder und erweiterte Felder ausblenden. (Außer Optionsfeld, Kontrollkästchen, Bild und Link).
Kontrollkästchenrahmen ausblenden	hideCheckboxBorder		boolean	Rahmen des Kontrollkästchens werden in den ausgeführten Dokumenten ausgeblendet.
Auswahloption "Signierer ausblenden"	hideSignerSelectOption		boolean	Wenn true, blendet es das Eingabefeld "Vorhandener Signierername/E-Mail" für Empfängerparteien in einer eingebetteten Sendesitzung aus.
Signieraktionen ausblenden	hideSignerActions		boolean	Wenn true, blendet es die Signiereraktionen "bearbeiten", "ändern" und "entfernen" für Empfängerparteien in einer eingebetteten Sendesitzung aus.
Absendername ausblenden	hideSenderName		boolean	Wenn true, blendet es den Namen des Absenders auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Ordnername ausblenden	hideFolderName		boolean	Wenn true, blendet es den Ordnernamen in beiden eingebetteten Sitzungen aus.
Dokumentname ausblenden	hideDocumentsName		boolean	Wenn true, blendet es den Dokumentnamen in beiden eingebetteten Sitzungen aus.
Ablehnen zum Signieren ausblenden	hideDeclineToSign		boolean	Wenn true, blendet es die Option "Ablehnen zum Signieren" für den Signierer aus.
Weitere Aktion ausblenden	hideMoreAction		boolean	Wenn true, wird die Schaltfläche "Weitere Aktionen" beim Senden/Signieren der Sitzung ausgeblendet. Im Falle von "Jetzt senden": true, wird nichts ausgeblendet.
Schaltfläche "Senden" ausblenden	hideSendButton		boolean	Wenn true, wird die Schaltfläche "Senden" in der eingebetteten Sendesitzung ausgeblendet.
Next Required Fieldbtn ausblenden	hideNextRequiredFieldbtn		boolean	Wenn dieser Wert auf "true" festgelegt ist, blendet die Navigationsschaltfläche aus, die Signierer in das nächste erforderliche Feld verschiebt.
Erforderliche eingebettete Sitzung	requiredBothEmbeddedSession		boolean	Wenn true, generiert sie die eingebetteten Sende- und Signatur-URLs zusammen.
Briefumschlagkennwort	folderPassword		string	Dieses Kennwort wird vom Signierer/Autor benötigt, um das digital signierte Dokument zu öffnen. Wenn der Parameter leer gehalten wird, ist kein Kennwort erforderlich, um das digital signierte Dokument zu öffnen.
Schritt für Schritt aktivieren	enableStepByStep		boolean	So aktivieren Sie schritt-für-Schritt-Aktion in der eingebetteten Sendesitzung.
Option "Parteien hinzufügen" ausblenden	hideAddPartiesOption		boolean	Wenn true, blendet es die Option zum Hinzufügen von Parteien im Entwurfs- und Vorlagenerstellungsmodus aus.
Selbstzeichen	selfSign		boolean	Es ermöglicht eingebettetes Self Sign über APIs. Dieser Parameter gilt nur, wenn der parameter createEmbeddedSendingSession true ist.
Self Signer Success Url	selfSignerSuccessUrl		string	Geben Sie die absolute URL für die Zielseite auf Ihrer Website/Anwendung ein, zu der der Benutzer nach dem erfolgreichen Senden des Ordners in der eingebetteten Sendeansicht umgeleitet wird.

Gibt zurück

Name	Pfad	Typ	Beschreibung
ID	folder.folderId	integer	Die eindeutige ID des neu erstellten Umschlags. Verwenden Sie dies in nachfolgenden Aktionen, um auf diesen Umschlag zu verweisen.
Name	folder.folderName	string	Der Name des neu erstellten Umschlags.
Benutzerdefinierter Name	folder.folderCustomName	string	Ein benutzerdefinierter Name für den Umschlag.
Password	folder.folderPassword	string	Das Zugriffskennwort für den Umschlag, falls festgelegt.
Ersteller-ID	folder.folderAuthorId	integer	Der eindeutige Bezeichner des Umschlagerstellers.
Creator Vorname	folder.folderAuthorFirstName	string	Der Vorname des Briefumschlagerstellers.
Creator-Nachname	folder.folderAuthorLastName	string	Der Nachname des Briefumschlagerstellers.
Creator-E-Mail	folder.folderAuthorEmail	string	Die E-Mail-Adresse des Briefumschlagerstellers.
Erstellerrolle	folder.folderAuthorRole	string	Die Rolle des Briefumschlagerstellers.
Unternehmens-ID	folder.folderCompanyId	integer	Der eindeutige Bezeichner des Unternehmens, das den Umschlag besitzt.
Erstellungsdatum	folder.folderCreationDate	integer	Das Datum, an dem der Umschlag erstellt wurde (Unix-Zeitstempel in Millisekunden).
Sendedatum	folder.folderSentDate	integer	Das Datum, an dem der Umschlag gesendet wurde (Unix-Zeitstempel in Millisekunden).
Status	folder.folderStatus	string	Der aktuelle Status des Umschlags.
Benutzerdefiniertes Feld 1	folder.custom_field1	string	Das erste benutzerdefinierte Metadatenfeld für den Umschlag.
Benutzerdefiniertes Feld 2	folder.custom_field2	string	Das zweite benutzerdefinierte Metadatenfeld für den Umschlag.
Metadaten	folder.metadata	string	Benutzerdefinierte Metadaten, die dem Umschlag zugeordnet sind.
Dokument-IDs	folder.folderDocumentIds	array of integer	Die Liste der Dokument-IDs, die im Umschlag enthalten sind.
Dokumente	folder.documentsList	array of object	Die Liste der Dokumente im Umschlag.
Dokument-ID	folder.documentsList.documentId	integer	Der eindeutige Bezeichner des Dokuments.
Vertrags-ID	folder.documentsList.contractId	integer	Der eindeutige Bezeichner des Vertrags.
Unternehmens-ID	folder.documentsList.companyId	integer	Der eindeutige Bezeichner des Unternehmens.
Erstellt von	folder.documentsList.contractCreatedBy	integer	Die Benutzer-ID der Person, die den Vertrag erstellt hat.
Erstellt am	folder.documentsList.contractCreatedOn	string	Das Datum und die Uhrzeit, zu dem der Vertrag erstellt wurde.
Vertragsart	folder.documentsList.contractType	string	Der Vertragstyp.
Vertragsstatus	folder.documentsList.contractStatus	string	Der aktuelle Status des Vertrags.
Bearbeitbar	folder.documentsList.editable	boolean	Gibt an, ob das Element bearbeitet werden kann.
Versions-ID	folder.documentsList.contractVersionId	integer	Der eindeutige Bezeichner der Vertragsversion.
Versionsname	folder.documentsList.contractVersionName	string	Der Name der Vertragsversion.
Versionsbeschreibung	folder.documentsList.contractVersionDesc	string	Eine Beschreibung der Vertragsversion.
Version erstellt von	folder.documentsList.versionCreatedby	integer	Die Benutzer-ID der Person, die diese Version erstellt hat.
Version erstellt am	folder.documentsList.versionCreatedOn	string	Das Datum und die Uhrzeit der Erstellung dieser Version.
Versionsnummer	folder.documentsList.contractVersionNumber	integer	Die Versionsnummer des Vertrags.
Transaktionsquelle	folder.documentsList.contractTransactionSource	string	Das Quellsystem, das die Vertragstransaktion initiiert hat.
Empfänger	folder.folderRecipientParties	array of object	Die Liste der Empfängerparteien für diesen Umschlag.
Empfänger-ID	folder.folderRecipientParties.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Empfänger-ID	folder.folderRecipientParties.partyDetails.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Vorname	folder.folderRecipientParties.partyDetails.firstName	string	Der Vorname des Empfängers.
Nachname	folder.folderRecipientParties.partyDetails.lastName	string	Der Nachname des Empfängers.
Email Adresse	folder.folderRecipientParties.partyDetails.emailId	string	Die E-Mail-Adresse des Empfängers.
Platzhalter	folder.folderRecipientParties.partyDetails.placeholder	boolean	Gibt an, ob es sich bei dieser Partei um einen Platzhalterempfänger handelt.
Adresse	folder.folderRecipientParties.partyDetails.address	string	Die physische Adresse des Empfängers.
Erstellt am	folder.folderRecipientParties.partyDetails.dateCreated	integer	Das Datum, an dem der Datensatz erstellt wurde (Unix-Zeitstempel in Millisekunden).
Abmelden von E-Mails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Gibt an, ob der Empfänger E-Mail-Benachrichtigungen deaktiviert hat.
Eindeutige Empfänger-ID	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Ein eindeutiger Systembezeichner für diesen Empfänger.
Authentifizierungsebene	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Die für diesen Empfänger erforderliche Authentifizierungsmethode.
Kennwort aktualisiert am	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Das Datum, an dem das Kennwort zuletzt aktualisiert wurde.
Status des Kennworts aktualisiert	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Gibt an, ob das Kennwort aktualisiert wurde.
Unternehmens-ID	folder.folderRecipientParties.partyDetails.companyId	integer	Der eindeutige Bezeichner des Unternehmens.
Benutzerrolle	folder.folderRecipientParties.partyDetails.userRole	string	Die dem Benutzer zugewiesene Rolle.
Abteilung	folder.folderRecipientParties.partyDetails.department	string	Die Abteilung, zu der der Benutzer gehört.
Title	folder.folderRecipientParties.partyDetails.title	string	Die Position des Benutzers.
Aktiv	folder.folderRecipientParties.partyDetails.active	boolean	Gibt an, ob der Benutzer oder Datensatz aktiv ist.
Gebietsschema	folder.folderRecipientParties.partyDetails.requestLocale	string	Die Gebietsschemaeinstellung für den Benutzer.
Mit Dept teilen	folder.folderRecipientParties.partyDetails.share_among_department	boolean	Gibt an, ob Umschläge für die gesamte Abteilung freigegeben werden.
Wählcode	folder.folderRecipientParties.partyDetails.dialingCode	string	Die internationale Wählnummer für die Telefonnummer.
Handynummer	folder.folderRecipientParties.partyDetails.mobileNumber	string	Die Mobiltelefonnummer.
Statusfilter	folder.folderRecipientParties.partyDetails.docStatusFilter	string	Ein Filter für den Dokumentstatus.
Datumsfilter	folder.folderRecipientParties.partyDetails.docDateFilter	string	Ein Filter für das Dokumentdatum.
Sicherer Feldzugriff	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	Gibt an, ob der Benutzer Zugriff auf sichere Felder hat.
Randleiste erweitern	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	Gibt an, ob die Randleiste standardmäßig erweitert wird.
Adv. E-Mail-Überprüfung	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	Gibt an, ob die erweiterte E-Mail-Überprüfung aktiviert ist.
Manager-ID	folder.folderRecipientParties.partyDetails.managerId	string	Der eindeutige Bezeichner des Vorgesetzten des Benutzers.
Anmeldeanzahl	folder.folderRecipientParties.partyDetails.loginCount	integer	Die Anzahl der Anmeldungen des Benutzers.
E-Mail-Kennwortzurücksetzung	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	Gibt an, ob eine E-Mail zur Kennwortzurücksetzung gesendet werden soll.
Abteilungs-ID	folder.folderRecipientParties.partyDetails.departmentId	string	Der eindeutige Bezeichner der Abteilung.
Primäres Unternehmen	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	Das primäre Unternehmen, das dem Benutzer zugeordnet ist.
Gerätetyp	folder.folderRecipientParties.partyDetails.deviceType	string	Der Typ des verwendeten Geräts.
Gerätetoken	folder.folderRecipientParties.partyDetails.deviceToken	string	Das Pushbenachrichtigungstoken für das Gerät.
Subunternehmerbeschreibung	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Eine Beschreibung des Subunternehmers oder des externen Signierers.
Subunternehmerorganisation	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Der Name der Organisation des Subunternehmers oder des externen Signierers.
Hinzugefügter Subunternehmerdatum	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Das Datum, an dem der Subunternehmer hinzugefügt wurde (Unix-Zeitstempel in Millisekunden).
Grundlage	folder.folderRecipientParties.partyDetails.source	string	Das Quellsystem, aus dem der externe Signierer hinzugefügt wurde.
Wählcode	folder.folderRecipientParties.dialingCode	string	Die internationale Wählnummer für die Telefonnummer.
Handynummer	folder.folderRecipientParties.mobileNumber	string	Die Mobiltelefonnummer.
Signaturtyp	folder.folderRecipientParties.signerSignatureType	string	Der Signaturtyp, den der Signierer verwendet.
Erlaubnisse	folder.folderRecipientParties.contractPermissions	string	Die Berechtigungen, die dieser Partei für den Vertrag erteilt wurden.
Signierreihenfolge	folder.folderRecipientParties.partySequence	integer	Die Sequenznummer der Signierreihenfolge für diesen Empfänger.
Workflowsequenz	folder.folderRecipientParties.workflowSignSequence	integer	Die Nummer der Workflowsignatursequenz.
Umschlag-ID	folder.folderRecipientParties.envelopeId	integer	Der eindeutige Bezeichner des Umschlags.
Firmen-ID des Empfängers	folder.folderRecipientParties.partyCompanyId	integer	Der eindeutige Bezeichner des Unternehmens, das diesem Empfänger zugeordnet ist.
Freigabemodus	folder.folderRecipientParties.sharingMode	string	Der Freigabemodus für diesen Umschlag.
Empfängerzugriffs-URL	folder.folderRecipientParties.folderAccessURL	string	Die URL, die der Empfänger verwenden kann, um auf den Umschlag zuzugreifen und zu signieren.
Sicherheitsmodus	folder.folderRecipientParties.securityMode	string	Der auf diesen Umschlag angewendete Sicherheitsmodus.
Kommentare	folder.folderRecipientParties.extraComments	string	Zusätzliche Kommentare, die im Umschlag enthalten sind.
Namensänderung zulassen	folder.folderRecipientParties.allowNameChange	boolean	Gibt an, ob der Empfänger seinen Namen aktualisieren darf.
Name aktualisiert	folder.folderRecipientParties.signerNameUpdated	boolean	Gibt an, ob der Signierer seinen Namen aktualisiert hat.
Signierer-Authentifizierungsebene	folder.folderRecipientParties.signerAuthenticationLevel	string	Die für den Signierer erforderliche Authentifizierungsstufe.
Zugangscode	folder.folderRecipientParties.userDefinedAccessCode	string	Ein benutzerdefinierter Zugriffscode, der für den Signierer definiert ist.
Signatur-ID	folder.folderRecipientParties.signatureId	string	Der eindeutige Bezeichner der Signatur.
Empfängerrolle	folder.folderRecipientParties.partyRole	string	Die diesem Empfänger zugewiesene Rolle im Signaturworkflow.
Firmenfeld	folder.folderRecipientParties.companyFieldValue	string	Der Wert des Firmennamenfelds in der Signatur.
Titelfeld	folder.folderRecipientParties.titleFieldValue	string	Der Wert des Titelfelds in der Signatur.
Grund für die Signierung	folder.folderRecipientParties.reasonSigning	string	Der Grund, warum der Empfänger das Dokument signiert.
Zahlungsfeld hinzugefügt	folder.folderRecipientParties.payFieldAdded	boolean	Gibt an, ob ein Zahlungsfeld hinzugefügt wurde.
Zahlungsempfänger	folder.folderRecipientParties.payee	boolean	Gibt an, ob dieser Empfänger der Zahlungsempfänger ist.
Wiederkehrende Zahlung	folder.folderRecipientParties.recurringFieldExist	boolean	Gibt an, ob ein wiederkehrendes Zahlungsfeld vorhanden ist.
Drucken und Signieren fertig	folder.folderRecipientParties.printAndSignCompleted	boolean	Gibt an, ob der Druck- und Signiervorgang abgeschlossen ist.
Bezahlt	folder.folderRecipientParties.paid	boolean	Gibt an, ob die Zahlung abgeschlossen wurde.
Optionaler Signierer zulässig	folder.folderRecipientParties.allowOptionalSigner	boolean	Gibt an, ob dieser Empfänger ein optionaler Signierer ist.
Optionale Signierer	folder.folderRecipientParties.optionalSigners	array of integer	Die Liste der optionalen Anmeldeprogramm-IDs für diesen Umschlag.
Signatur-URL des Autors	folder.folderAccessURLForAuthor	string	Die URL, die der Absender für den Zugriff auf den Umschlag verwenden kann.
Url des Entwurfszugriffs	folder.draftFolderAccessURL	string	Die URL, die für den Zugriff auf die Entwurfsversion des Umschlags verwendet wird.
BoardroomSignatur	folder.boardRoomSign	boolean	Gibt an, ob der Boardroomsignierungsmodus aktiviert ist.
Logo einschließen	folder.includeLogo	boolean	Gibt an, ob das Firmenlogo in E-Mails enthalten ist.
Schaltflächenhintergrundfarbe	folder.email_btnBgColor	string	Die Hintergrundfarbe der Schaltfläche "E-Mail".
Schaltflächentextfarbe	folder.email_btnTxtColor	string	Die Textfarbe der Schaltfläche "E-Mail".
E-Mail-Logo	folder.emailTemplateLogo	string	Die logo-URL, die in der E-Mail-Vorlage verwendet wird.
E-Mail-Vorlagen-ID	folder.emailTemplateId	integer	Der eindeutige Bezeichner der E-Mail-Vorlage.
E-Mail-Kopfzeile	folder.emailHeader	string	Der Kopfzeilentext, der in Benachrichtigungs-E-Mails verwendet wird.
E-Mail-Fußzeile	folder.emailFooter	string	Der Fußzeilentext, der in Benachrichtigungs-E-Mails verwendet wird.
Geplante Bereinigung	folder.purgeFlag	boolean	Gibt an, ob der Umschlag für die Bereinigung geplant ist.
Startdatum löschen	folder.purgeStartDate	string	Das Datum, ab dem die Bereinigung beginnen soll.
Enddatum löschen	folder.purgeEndDate	string	Das Datum, an dem die Bereinigung abgeschlossen werden soll.
Massensendungs-ID	folder.bulkId	integer	Der eindeutige Bezeichner des Massensendungsvorgangs.
Signierreihenfolge erzwingen	folder.enforceSignWorkflow	boolean	Gibt an, ob sich Empfänger bei der definierten Sequenz anmelden müssen.
Aktueller Schritt	folder.currentWorkflowStep	integer	Der aktuelle Schritt im Signaturworkflow.
Transaktionsquelle	folder.transactionSource	string	Das Quellsystem, das diese Transaktion initiiert hat.
Bearbeitbar	folder.editable	boolean	Gibt an, ob das Element bearbeitet werden kann.
In-Person Signierung	folder.inPersonSignable	boolean	Gibt an, ob der Umschlag persönlich angemeldet werden kann.
Überschreiben von Erinnerungen	folder.overrideAccountReminders	boolean	Gibt an, ob Erinnerungseinstellungen auf Kontoebene überschrieben werden.
Delegierung außer Kraft setzen	folder.overrideAccountRecipientDelegation	boolean	Gibt an, ob Delegierungseinstellungen auf Kontoebene überschrieben werden.
Delegierung zulassen	folder.allowRecipientsToDelegate	boolean	Gibt an, ob Empfänger die Signierung delegieren dürfen.
ID	folder.envelopeId	integer	Der eindeutige Bezeichner des Umschlags.
Name	folder.envelopeName	string	Der Name des Umschlags.
Absender-ID	folder.envelopeOriginatorId	integer	Der eindeutige Bezeichner des Benutzers, der den Umschlag erstellt hat.
Unternehmens-ID	folder.envelopeCompanyId	integer	Der eindeutige Bezeichner des Unternehmens, das den Umschlag besitzt.
Datum	folder.envelopeDate	integer	Das Datum, an dem der Umschlag erstellt wurde (Unix-Zeitstempel in Millisekunden).
Freigegebenes Datum	folder.envelopeSharedDate	integer	Das Datum, an dem der Umschlag geteilt wurde (Unix-Zeitstempel in Millisekunden).
Status	folder.envelopeStatus	string	Der aktuelle Status des Umschlags.
Vertrags-IDs	folder.envelopeContractIds	array of integer	Die Liste der Vertrags-IDs, die diesem Umschlag zugeordnet sind.
Empfängerberechtigungen	folder.envelopePartyPermissions	array of object	Die Liste der Empfängerberechtigungen für diesen Umschlag.
Empfänger-ID	folder.envelopePartyPermissions.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Empfänger-ID	folder.envelopePartyPermissions.partyDetails.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Vorname	folder.envelopePartyPermissions.partyDetails.firstName	string	Der Vorname des Empfängers.
Nachname	folder.envelopePartyPermissions.partyDetails.lastName	string	Der Nachname des Empfängers.
Email Adresse	folder.envelopePartyPermissions.partyDetails.emailId	string	Die E-Mail-Adresse des Empfängers.
Platzhalter	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	Gibt an, ob es sich bei dieser Partei um einen Platzhalterempfänger handelt.
Adresse	folder.envelopePartyPermissions.partyDetails.address	string	Die physische Adresse des Empfängers.
Erstellt am	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	Das Datum, an dem der Datensatz erstellt wurde (Unix-Zeitstempel in Millisekunden).
Abmelden von E-Mails	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	Gibt an, ob der Empfänger E-Mail-Benachrichtigungen deaktiviert hat.
Eindeutige Empfänger-ID	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	Ein eindeutiger Systembezeichner für diesen Empfänger.
Authentifizierungsebene	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	Die für diesen Empfänger erforderliche Authentifizierungsmethode.
Kennwort aktualisiert am	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	Das Datum, an dem das Kennwort zuletzt aktualisiert wurde.
Status des Kennworts aktualisiert	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	Gibt an, ob das Kennwort aktualisiert wurde.
Unternehmens-ID	folder.envelopePartyPermissions.partyDetails.companyId	integer	Der eindeutige Bezeichner des Unternehmens.
Benutzerrolle	folder.envelopePartyPermissions.partyDetails.userRole	string	Die dem Benutzer zugewiesene Rolle.
Abteilung	folder.envelopePartyPermissions.partyDetails.department	string	Die Abteilung, zu der der Benutzer gehört.
Title	folder.envelopePartyPermissions.partyDetails.title	string	Die Position des Benutzers.
Aktiv	folder.envelopePartyPermissions.partyDetails.active	boolean	Gibt an, ob der Benutzer oder Datensatz aktiv ist.
Gebietsschema	folder.envelopePartyPermissions.partyDetails.requestLocale	string	Die Gebietsschemaeinstellung für den Benutzer.
Mit Dept teilen	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	Gibt an, ob Umschläge für die gesamte Abteilung freigegeben werden.
Wählcode	folder.envelopePartyPermissions.partyDetails.dialingCode	string	Die internationale Wählnummer für die Telefonnummer.
Handynummer	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	Die Mobiltelefonnummer.
Statusfilter	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	Ein Filter für den Dokumentstatus.
Datumsfilter	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	Ein Filter für das Dokumentdatum.
Sicherer Feldzugriff	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	Gibt an, ob der Benutzer Zugriff auf sichere Felder hat.
Randleiste erweitern	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	Gibt an, ob die Randleiste standardmäßig erweitert wird.
Adv. E-Mail-Überprüfung	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	Gibt an, ob die erweiterte E-Mail-Überprüfung aktiviert ist.
Manager-ID	folder.envelopePartyPermissions.partyDetails.managerId	string	Der eindeutige Bezeichner des Vorgesetzten des Benutzers.
Anmeldeanzahl	folder.envelopePartyPermissions.partyDetails.loginCount	integer	Die Anzahl der Anmeldungen des Benutzers.
E-Mail-Kennwortzurücksetzung	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	Gibt an, ob eine E-Mail zur Kennwortzurücksetzung gesendet werden soll.
Abteilungs-ID	folder.envelopePartyPermissions.partyDetails.departmentId	string	Der eindeutige Bezeichner der Abteilung.
Primäres Unternehmen	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	Das primäre Unternehmen, das dem Benutzer zugeordnet ist.
Gerätetyp	folder.envelopePartyPermissions.partyDetails.deviceType	string	Der Typ des verwendeten Geräts.
Gerätetoken	folder.envelopePartyPermissions.partyDetails.deviceToken	string	Das Pushbenachrichtigungstoken für das Gerät.
Subunternehmerbeschreibung	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	Eine Beschreibung des Subunternehmers oder des externen Signierers.
Subunternehmerorganisation	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	Der Name der Organisation des Subunternehmers oder des externen Signierers.
Hinzugefügter Subunternehmerdatum	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	Das Datum, an dem der Subunternehmer hinzugefügt wurde (Unix-Zeitstempel in Millisekunden).
Grundlage	folder.envelopePartyPermissions.partyDetails.source	string	Das Quellsystem, aus dem der externe Signierer hinzugefügt wurde.
Wählcode	folder.envelopePartyPermissions.dialingCode	string	Die internationale Wählnummer für die Telefonnummer.
Handynummer	folder.envelopePartyPermissions.mobileNumber	string	Die Mobiltelefonnummer.
Signaturtyp	folder.envelopePartyPermissions.signerSignatureType	string	Der Signaturtyp, den der Signierer verwendet.
Erlaubnisse	folder.envelopePartyPermissions.contractPermissions	string	Die Berechtigungen, die dieser Partei für den Vertrag erteilt wurden.
Signierreihenfolge	folder.envelopePartyPermissions.partySequence	integer	Die Sequenznummer der Signierreihenfolge für diesen Empfänger.
Workflowsequenz	folder.envelopePartyPermissions.workflowSignSequence	integer	Die Nummer der Workflowsignatursequenz.
Umschlag-ID	folder.envelopePartyPermissions.envelopeId	integer	Der eindeutige Bezeichner des Umschlags.
Firmen-ID des Empfängers	folder.envelopePartyPermissions.partyCompanyId	integer	Der eindeutige Bezeichner des Unternehmens, das diesem Empfänger zugeordnet ist.
Freigabemodus	folder.envelopePartyPermissions.sharingMode	string	Der Freigabemodus für diesen Umschlag.
Empfängerzugriffs-URL	folder.envelopePartyPermissions.folderAccessURL	string	Die URL, die der Empfänger verwenden kann, um auf den Umschlag zuzugreifen und zu signieren.
Sicherheitsmodus	folder.envelopePartyPermissions.securityMode	string	Der auf diesen Umschlag angewendete Sicherheitsmodus.
Kommentare	folder.envelopePartyPermissions.extraComments	string	Zusätzliche Kommentare, die im Umschlag enthalten sind.
Namensänderung zulassen	folder.envelopePartyPermissions.allowNameChange	boolean	Gibt an, ob der Empfänger seinen Namen aktualisieren darf.
Name aktualisiert	folder.envelopePartyPermissions.signerNameUpdated	boolean	Gibt an, ob der Signierer seinen Namen aktualisiert hat.
Signierer-Authentifizierungsebene	folder.envelopePartyPermissions.signerAuthenticationLevel	string	Die für den Signierer erforderliche Authentifizierungsstufe.
Zugangscode	folder.envelopePartyPermissions.userDefinedAccessCode	string	Ein benutzerdefinierter Zugriffscode, der für den Signierer definiert ist.
Signatur-ID	folder.envelopePartyPermissions.signatureId	string	Der eindeutige Bezeichner der Signatur.
Empfängerrolle	folder.envelopePartyPermissions.partyRole	string	Die diesem Empfänger zugewiesene Rolle im Signaturworkflow.
Firmenfeld	folder.envelopePartyPermissions.companyFieldValue	string	Der Wert des Firmennamenfelds in der Signatur.
Titelfeld	folder.envelopePartyPermissions.titleFieldValue	string	Der Wert des Titelfelds in der Signatur.
Grund für die Signierung	folder.envelopePartyPermissions.reasonSigning	string	Der Grund, warum der Empfänger das Dokument signiert.
Zahlungsfeld hinzugefügt	folder.envelopePartyPermissions.payFieldAdded	boolean	Gibt an, ob ein Zahlungsfeld hinzugefügt wurde.
Zahlungsempfänger	folder.envelopePartyPermissions.payee	boolean	Gibt an, ob dieser Empfänger der Zahlungsempfänger ist.
Wiederkehrende Zahlung	folder.envelopePartyPermissions.recurringFieldExist	boolean	Gibt an, ob ein wiederkehrendes Zahlungsfeld vorhanden ist.
Drucken und Signieren fertig	folder.envelopePartyPermissions.printAndSignCompleted	boolean	Gibt an, ob der Druck- und Signiervorgang abgeschlossen ist.
Bezahlt	folder.envelopePartyPermissions.paid	boolean	Gibt an, ob die Zahlung abgeschlossen wurde.
Authentifizierungsebene	folder.envelopeAuthenticationLevel	string	Die für den Umschlag erforderliche Authentifizierungsstufe.
Massenhinzufügen von Single Signer	folder.allowSingleSignerInBulk	boolean	Gibt an, ob ein Single Signer im Massensendungsmodus zulässig ist.
File-Based Benennung	folder.folderNameBasedOnFileNaming	boolean	Gibt an, ob der Ordnername auf dem Dateinamen basiert.
Doc File-Based Name	folder.documentNameBasedOnFileNaming	boolean	Gibt an, ob der Dokumentname auf dem Dateinamen basiert.
Name des Zertifikats File-Based	folder.certificateNameBasedOnFileNaming	boolean	Gibt an, ob der Zertifikatname auf dem Dateinamen basiert.
Prä-Exec-Dateibenennung	folder.enableFileNamingBeforeExecution	boolean	Gibt an, ob die Dateibenennung vor der Dokumentausführung aktiviert ist.
Payee hinzugefügt	folder.payeeAddedd	boolean	Gibt an, ob ein Zahlungsempfänger hinzugefügt wurde.
Self-Signing aktiviert	folder.selfSignerEnabled	boolean	Gibt an, ob der Selbstsignierungsmodus aktiviert ist.
Notar aktiviert	folder.notaryEnabled	boolean	Gibt an, ob die Notarsignierung aktiviert ist.
Eingeschränkte Sichtbarkeit	folder.limitedVisibilityFlag	boolean	Gibt an, ob die eingeschränkte Sichtbarkeit für diesen Umschlag aktiviert ist.
Sichtbarkeit nach dem Signieren	folder.postSigningVisibility	boolean	Gibt an, ob die Sichtbarkeit nach dem Signieren aktiviert ist.
Nasse Signatur	folder.wetSignatureEnabled	boolean	Gibt an, ob nasse Signaturen aktiviert sind.
Seriendruck aktiviert	folder.mergeEnabled	boolean	Gibt an, ob das Zusammenführen von Dokumenten aktiviert ist.
Eingebettete Signatursitzungen	embeddedSigningSessions	array of object	Die Liste der eingebetteten Signatursitzungen, eine pro Empfänger. Nur vorhanden, wenn createEmbeddedSigningSession true ist.
Signierer-E-Mail	embeddedSigningSessions.emailIdOfSigner	string	Die E-Mail-Adresse des Empfängers für diese eingebettete Signatursitzung.
Signaturtoken	embeddedSigningSessions.embeddedToken	string	Das eindeutige Token für die eingebettete Signatursitzung dieses Empfängers.
Signatursitzungs-URL	embeddedSigningSessions.embeddedSessionURL	string	Die URL, die für diesen Empfänger geöffnet oder eingebettet werden soll, um das Dokument zu signieren.
Eingebettetes Senden von Token	embeddedToken	string	Das Token für die eingebettete Sendesitzung. Nur vorhanden, wenn createEmbeddedSendingSession true ist.
Senden der Sitzungs-URL	embeddedSessionURL	string	Die URL zum Öffnen oder Einbetten des Umschlagautors, um den Umschlag vorzubereiten und zu senden. Nur vorhanden, wenn createEmbeddedSendingSession true ist.
Result	result	string	Das Ergebnis des Vorgangs.
Nachricht	message	string	Eine Meldung, die das Ergebnis des Vorgangs beschreibt.

Briefumschlag-IDs abrufen

Vorgangs-ID:: GetEnvelopeIds

Gibt eine Liste von Umschlag-IDs zurück, die nach Status gefiltert werden. Verwenden Sie diese Option, um Umschläge in einem bestimmten Zustand zu finden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Datum von	dateFrom	True	string	Beginn des Umschlagerstellungsdatumsbereichs. Akzeptiertes Format: JJJJ-MM-TT.
Datum bis	dateTo	True	string	Ende des Umschlagerstellungsdatumsbereichs. Akzeptiertes Format: JJJJ-MM-TT. Der DateTo-Wert muss innerhalb von 6 Monaten nach dem DateFrom-Wert sein.
Status	status		string	Filtern sie Umschläge nach Status. Akzeptierte Werte: AUSGEFÜHRT, FREIGEGEBEN, ENTWURF, TEILWEISE SIGNIERT, ABGEBROCHEN, ABGELAUFEN, GELÖSCHT. Wenn sie weggelassen wird, werden Umschläge mit einem beliebigen Status zurückgegeben.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
Nachricht	message	string	Eine Zusammenfassungsmeldung, die angibt, wie viele Umschlag-IDs zurückgegeben wurden.
Umschlag-IDs	allFolderIds	array of integer	Die Liste der Umschlag-IDs, die den Filterkriterien entsprechen. Verwenden Sie diese IDs mit "Umschlagdetails abrufen", um vollständige Umschlaginformationen abzurufen.

Briefumschlagdetails abrufen

Vorgangs-ID:: GetEnvelopeDetails

Ruft vollständige Details eines Umschlags ab, einschließlich status, Empfänger und Dokumente.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschlag-ID	folderId	True	integer	Der eindeutige Bezeichner des abzurufenden Umschlags.
Zugriffstoken	access_token		string	Das OAuth 2.0-Zugriffstoken für die Authentifizierung.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, ob der Vorgang erfolgreich war (z. B. "success").
ID	folder.folderId	integer	Die eindeutige ID des Umschlags.
Name	folder.folderName	string	Der Name des Umschlags.
Autor-ID	folder.folderAuthorId	integer	Die eindeutige ID des Benutzers, der den Umschlag erstellt hat.
Vorname des Autors	folder.folderAuthorFirstName	string	Der Vorname des Briefumschlagerstellers.
Nachname des Autors	folder.folderAuthorLastName	string	Der Nachname des Briefumschlagerstellers.
Email erstellen	folder.folderAuthorEmail	string	Die E-Mail-Adresse des Briefumschlagerstellers.
Autorrolle	folder.folderAuthorRole	string	Die Kontorolle des Umschlagerstellers.
Unternehmens-ID	folder.folderCompanyId	integer	Die eindeutige ID des Unternehmens, zu dem der Umschlag gehört.
Erstellungsdatum	folder.folderCreationDate	integer	Das Datum und die Uhrzeit, zu dem der Umschlag erstellt wurde, in Unix Millisekunden.
Sendedatum	folder.folderSentDate	integer	Das Datum und die Uhrzeit, zu der der Umschlag an die Empfänger gesendet wurde, in Unix Millisekunden. Null, wenn noch nicht gesendet.
Status	folder.folderStatus	string	Der aktuelle Status des Umschlags (z. B. FREIGEGEBEN, AUSGEFÜHRT, ENTWURF, ABGEBROCHEN).
Dokument-IDs	folder.folderDocumentIds	array of integer	Die Liste der Dokument-IDs, die in diesem Umschlag enthalten sind.
Dokumente	folder.documentsList	array of object	Details zu jedem Dokument, das im Umschlag enthalten ist.
Dokument-ID	folder.documentsList.documentId	integer	Der eindeutige Bezeichner des Dokuments.
Vertrags-ID	folder.documentsList.contractId	integer	Der eindeutige Bezeichner des Vertrags, der diesem Dokument zugeordnet ist.
Unternehmens-ID	folder.documentsList.companyId	integer	Die eindeutige ID des Unternehmens, zu dem dieses Dokument gehört.
Erstellt von	folder.documentsList.contractCreatedBy	integer	Die Benutzer-ID der Person, die den Vertrag erstellt hat.
Erstellt am	folder.documentsList.contractCreatedOn	integer	Das Datum, an dem der Vertrag erstellt wurde, in Unix Millisekunden.
Vertragsart	folder.documentsList.contractType	string	Der Typ oder die Kategorie des Vertrags.
Dokumentstatus	folder.documentsList.contractStatus	string	Der aktuelle Signaturstatus des Dokuments (z. B. WAITING_FOR_SIGNATURE, AUSGEFÜHRT).
Bearbeitbar	folder.documentsList.editable	boolean	Gibt an, ob das Dokument bearbeitet werden kann.
Versions-ID	folder.documentsList.contractVersionId	integer	Die eindeutige ID der aktuellen Dokumentversion.
Versionsname	folder.documentsList.contractVersionName	string	Der Name der aktuellen Dokumentversion.
Versionsbeschreibung	folder.documentsList.contractVersionDesc	string	Eine Beschreibung der aktuellen Dokumentversion.
Version erstellt von	folder.documentsList.versionCreatedby	integer	Die Benutzer-ID der Person, die diese Dokumentversion erstellt hat.
Version erstellt am	folder.documentsList.versionCreatedOn	integer	Das Datum, an dem diese Dokumentversion erstellt wurde, in Unix Millisekunden.
Versionsnummer	folder.documentsList.contractVersionNumber	integer	Die Versionsnummer des Dokuments.
Empfänger	folder.folderRecipientParties	array of object	Die Liste der Empfänger für diesen Umschlag, einschließlich ihres Signaturstatus und Zugriffslinks.
Empfänger-ID	folder.folderRecipientParties.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Empfänger-ID	folder.folderRecipientParties.partyDetails.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Vorname	folder.folderRecipientParties.partyDetails.firstName	string	Der Vorname des Empfängers.
Nachname	folder.folderRecipientParties.partyDetails.lastName	string	Der Nachname des Empfängers.
Email	folder.folderRecipientParties.partyDetails.emailId	string	Die E-Mail-Adresse des Empfängers.
Adresse	folder.folderRecipientParties.partyDetails.address	string	Die Adresse des Empfängers.
Erstellungsdatum des Kontos	folder.folderRecipientParties.partyDetails.dateCreated	integer	Das Datum, an dem das Konto des Empfängers erstellt wurde, in Unix Millisekunden.
Erlaubnisse	folder.folderRecipientParties.contractPermissions	string	Die diesem Empfänger erteilten Signaturberechtigungen (z. B. FILL_FIELDS_AND_SIGN).
Signierreihenfolge	folder.folderRecipientParties.partySequence	integer	Die Position dieses Empfängers in der Signierreihenfolge.
Workflowsequenz	folder.folderRecipientParties.workflowSignSequence	integer	Die Sequenznummer der Workflowsignatur für diesen Empfänger.
Umschlag-ID	folder.folderRecipientParties.envelopeId	integer	Die ID des Umschlags, zu dem dieser Empfänger gehört.
Freigabemodus	folder.folderRecipientParties.sharingMode	string	Die Methode, mit der das Dokument für diesen Empfänger freigegeben wird (z. B. E-Mail).
Signatur-URL	folder.folderRecipientParties.folderAccessURL	string	Die eindeutige Signatur-URL für diesen Empfänger. Null, wenn der Umschlag bereits abgeschlossen oder abgebrochen wurde.
Sicherheitsmodus	folder.folderRecipientParties.securityMode	string	Der Sicherheitsmodus, der auf den Zugriff dieses Empfängers angewendet wurde.
Zusätzliche Kommentare	folder.folderRecipientParties.extraComments	string	Alle zusätzlichen Kommentare, die in der Signiereinladung für diesen Empfänger enthalten sind.
Zugriffs-URL des Autors	folder.folderAccessURLForAuthor	string	Die URL für den Umschlagautor, um auf das Dokument zuzugreifen. NULL, wenn nicht zutreffend.
Massen-ID	folder.bulkId	integer	Die ID des Massensendungsbatches, zu dem dieser Umschlag gehört, falls vorhanden.
Signierreihenfolge erzwingen	folder.enforceSignWorkflow	boolean	Gibt an, ob die Empfänger sich in der angegebenen Reihenfolge anmelden müssen.
Aktueller Workflowschritt	folder.currentWorkflowStep	integer	Der aktuelle Schritt im Signaturworkflow.
Transaktionsquelle	folder.transactionSource	string	Die Quelle, die diese Umschlagtransaktion initiiert hat.
Bearbeitbar	folder.editable	boolean	Gibt an, ob der Umschlag noch bearbeitet werden kann.
In-Person Signierung	folder.inPersonSignable	boolean	Gibt an, ob der Umschlag persönlich angemeldet werden kann.
Überschreiben von Erinnerungen	folder.overrideAccountReminders	boolean	Gibt an, ob Erinnerungseinstellungen auf Kontoebene für diesen Umschlag außer Kraft gesetzt werden.
ID	folder.envelopeId	integer	Die eindeutige ID des Umschlags. Derselbe Wert wie Umschlag-ID (folderId).
Name	folder.envelopeName	string	Der Name des Umschlags. Derselbe Wert wie Umschlagname (FolderName).
Absender-ID	folder.envelopeOriginatorId	integer	Die Benutzer-ID der Person, die den Umschlag erstellt hat.
Unternehmens-ID	folder.envelopeCompanyId	integer	Die ID des Unternehmens, zu dem der Umschlag gehört.
Datum	folder.envelopeDate	integer	Das Datum und die Uhrzeit, zu dem der Umschlag erstellt wurde, in Unix Millisekunden.
Freigegebenes Datum	folder.envelopeSharedDate	integer	Das Datum und die Uhrzeit, zu der der Umschlag für Empfänger freigegeben wurde, in Unix Millisekunden. Null, wenn noch nicht freigegeben.
Status	folder.envelopeStatus	string	Der aktuelle Status des Umschlags. Derselbe Wert wie Umschlagstatus (folderStatus).
Vertrags-IDs	folder.envelopeContractIds	array of integer	Die Liste der Vertrags-IDs, die diesem Umschlag zugeordnet sind.
Partyberechtigungen	folder.envelopePartyPermissions	array of object	Die Liste der Empfänger und deren Signaturberechtigungen. Gleiche Struktur wie Empfänger.
Empfänger-ID	folder.envelopePartyPermissions.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Vorname	folder.envelopePartyPermissions.partyDetails.firstName	string	Der Vorname des Empfängers.
Nachname	folder.envelopePartyPermissions.partyDetails.lastName	string	Der Nachname des Empfängers.
Email	folder.envelopePartyPermissions.partyDetails.emailId	string	Die E-Mail-Adresse des Empfängers.
Erlaubnisse	folder.envelopePartyPermissions.contractPermissions	string	Die Signaturberechtigungen für diesen Empfänger.
Signierreihenfolge	folder.envelopePartyPermissions.partySequence	integer	Die Position dieses Empfängers in der Signierreihenfolge.
Signatur-URL	folder.envelopePartyPermissions.folderAccessURL	string	Die eindeutige Signatur-URL für diesen Empfänger.
Alle Felder	allFields	array of object	Die Liste aller Signatur- und Formularfelder, die in den Dokumenten des Umschlags platziert werden.
Feld-ID	allFields.fieldTagId	integer	Der eindeutige Bezeichner des Felds.
Dokument-ID	allFields.contractId	integer	Die ID des Dokuments, zu dem dieses Feld gehört.
Versions-ID	allFields.versionId	integer	Die Versions-ID des Dokuments, zu dem dieses Feld gehört.
Feldtyp	allFields.fieldType	string	Der Typ des Felds (z. B. Zeichenfeld, Textfeld, Datumsfeld, Kontrollkästchenfeld, Dropdownfeld, Initialfeld).
Seitennummer	allFields.documentPageNumber	integer	Die Seitenzahl, in der dieses Feld platziert wird.
Felddokument-ID	allFields.docFieldId	string	Der Bezeichner auf Dokumentebene für dieses Feld.
Verantwortliche Partei	allFields.partyResponsible	integer	Die Partei-ID, die für das Ausfüllen dieses Felds verantwortlich ist.
Ist abhängig	allFields.dependent	boolean	Gibt an, ob die Sichtbarkeit dieses Felds vom Wert eines anderen Felds abhängt.
Erforderlich	allFields.required	boolean	Gibt an, ob dieses Feld ausgefüllt werden muss, bevor das Dokument übermittelt werden kann.
Feldwert	allFields.value	string	Der aktuelle Wert des Felds, falls ausgefüllt.
Feldwerte	allFieldsNameValue	array of object	Eine vereinfachte Liste aller Feldnamen und deren aktuelle Werte. Verwenden Sie diese Einstellung, um gefüllte Felddaten aus einem signierten Umschlag zu lesen.
Feld-ID	allFieldsNameValue.fieldId	integer	Der eindeutige Bezeichner des Felds.
Dokument-ID	allFieldsNameValue.documentId	integer	Die ID des Dokuments, zu dem dieses Feld gehört.
Versions-ID	allFieldsNameValue.documentVersionId	integer	Die Versions-ID des Dokuments, zu dem dieses Feld gehört.
Feldtyp	allFieldsNameValue.fieldType	string	Der Typ des Felds (z. B. Textfeld, Zeichenfeld, Datumsfeld, Kontrollkästchenfeld, Dropdownfeld).
Feldname	allFieldsNameValue.name	string	Die Bezeichnung oder der Name des Felds, wie in der Vorlage definiert.
Feldwert	allFieldsNameValue.value	string	Der für dieses Feld eingegebene oder ausgewählte Wert.
Briefumschlaghistorie	Folder History	array of object	Der Überwachungspfad aller Aktionen, die auf diesem Umschlag ausgeführt wurden, in chronologischer Reihenfolge.
Vorname	Folder History.firstName	string	Der Vorname der Person, die die Aktion ausgeführt hat.
Nachname	Folder History.lastName	string	Der Nachname der Person, die die Aktion ausgeführt hat.
Email	Folder History.email	string	Die E-Mail-Adresse der Person, die die Aktion ausgeführt hat.
Umschlag-ID	Folder History.envelopeId	integer	Die ID des Umschlags, auf dem die Aktion ausgeführt wurde.
Datum	Folder History.dateChanged	integer	Das Datum und die Uhrzeit der Aktion in Unix Millisekunden.
Partei-ID	Folder History.changeDoneByParty	integer	Die Partei-ID der Person, die die Aktion ausgeführt hat.
Aktivität	Folder History.action	string	Die Aktion, die auf dem Umschlag ausgeführt wurde (z. B. "Erstellt", "InviteSentTo", "InviteAccepted", "Signed", "Ausgeführt").

E-Mail-Gruppe erstellen

Vorgangs-ID:: CreateEmailGroup

Erstellt eine neue E-Mail-Gruppe, mit der Briefumschläge gleichzeitig an mehrere Empfänger gesendet werden können.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Gruppenname	emailGroupName	True	string	Der Name für die neue E-Mail-Gruppe.
Gruppenbeschreibung	emailGroupDescription		string	Eine optionale Beschreibung für die E-Mail-Gruppe.
Erweiterte E-Mail-Überprüfung zulassen	allowAdvancedEmailValidation		boolean	Wenn diese Option aktiviert ist, überprüft Foxit eSign, dass alle E-Mail-Adressen in der Gruppe vor dem Senden erreichbar sind.
Vorname	firstName	True	string	Der Vorname des Empfängers.
Nachname	lastName	True	string	Der Nachname des Empfängers.
Email	emailId	True	string	Die E-Mail-Adresse des Empfängers.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
Nachricht	message	string	Eine Bestätigungsmeldung für die ausgeführte Aktion.
Gruppen-ID	emailGroup.groupId	integer	Der eindeutige Bezeichner der E-Mail-Gruppe. Verwenden Sie diese ID beim Senden von Umschlägen an die Gruppe.
Gruppenname	emailGroup.groupName	string	Der Name der E-Mail-Gruppe.
Gruppenbeschreibung	emailGroup.groupDesc	string	Die Beschreibung der E-Mail-Gruppe.
Erstellt am	emailGroup.dateCreated	integer	Das Datum, an dem die E-Mail-Gruppe erstellt wurde, in Unix Millisekunden.
Unternehmens-ID	emailGroup.companyId	integer	Das Firmenkonto, zu dem diese E-Mail-Gruppe gehört.
Parties	emailGroup.parties	array of object	Die Liste der Empfänger in der E-Mail-Gruppe.
Vorname	emailGroup.parties.firstName	string	Der Vorname des Empfängers.
Nachname	emailGroup.parties.lastName	string	Der Nachname des Empfängers.
Email	emailGroup.parties.emailId	string	Die E-Mail-Adresse des Empfängers.

E-Mail-Gruppendetails abrufen

Vorgangs-ID:: GetEmailGroupDetails

Ruft Details einer vorhandenen E-Mail-Gruppe ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
E-Mail-Gruppennamen	emailGroupNames	True	array of string	Ein Array von E-Mail-Gruppennamen, die zum Identifizieren der Gruppen verwendet werden.

Gibt zurück

Name	Pfad	Typ	Beschreibung
E-Mail-Gruppen	allEmailGroups	array of object	Die Liste der E-Mail-Gruppen, die den angeforderten Gruppennamen entsprechen.
Gruppen-ID	allEmailGroups.groupId	integer	Der eindeutige Bezeichner der E-Mail-Gruppe.
Gruppenname	allEmailGroups.groupName	string	Der Name der E-Mail-Gruppe.
Gruppenbeschreibung	allEmailGroups.groupDesc	string	Die Beschreibung der E-Mail-Gruppe.
Erstellt am	allEmailGroups.dateCreated	integer	Das Datum, an dem die E-Mail-Gruppe erstellt wurde, in Unix Millisekunden.
Unternehmens-ID	allEmailGroups.companyId	integer	Das Firmenkonto, zu dem diese E-Mail-Gruppe gehört.
Parties	allEmailGroups.parties	array of object	Die Liste der Empfänger in dieser E-Mail-Gruppe.
Vorname	allEmailGroups.parties.firstName	string	Der Vorname des Empfängers.
Nachname	allEmailGroups.parties.lastName	string	Der Nachname des Empfängers.
Email	allEmailGroups.parties.emailId	string	Die E-Mail-Adresse des Empfängers.

Löschen des Umschlagverlaufs abrufen

Vorgangs-ID:: GetDeletedEnvelopeHistory

Ruft einen Verlauf von Umschlägen ab, die gelöscht oder in den Papierkorb verschoben wurden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschlag-ID	folderId	True	string	Der eindeutige Bezeichner des Umschlags, dessen Löschverlauf Sie abrufen möchten.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
Umschlaginformationen gelöscht	Deleted Folder Log Info	array of object	Zusammenfassungsinformationen zum gelöschten Umschlag.
Umschlag-ID	Deleted Folder Log Info.folderId	integer	Der eindeutige Bezeichner des gelöschten Umschlags.
Umschlagname	Deleted Folder Log Info.folderName	string	Der Name des gelöschten Umschlags.
Dokumentname	Deleted Folder Log Info.documentName	string	Der Name des Dokuments im gelöschten Umschlag.
Dokument-ID	Deleted Folder Log Info.documentId	string	Der eindeutige Bezeichner des Dokuments im gelöschten Umschlag.
Löschdatum	Deleted Folder Log Info.deletionDate	integer	Das Datum und die Uhrzeit, zu dem der Umschlag gelöscht wurde, in Unix Millisekunden.
Gelöscht von	Deleted Folder Log Info.deletedBy	string	Der Name des Benutzers, der den Umschlag gelöscht hat.
Verlauf des Löschprotokolls	Deleted Folder Log History	array of object	Das schrittweise Protokoll aller Löschaktionen, die auf dem Umschlag ausgeführt werden.
Ausgeführt von	Deleted Folder Log History.partiesName	string	Der Name des Benutzers, der den Löschschritt ausgeführt hat.
Grundlage	Deleted Folder Log History.source	string	Die Quelle, aus der der Löschvorgang initiiert wurde (z. B. Web, API).
Event	Deleted Folder Log History.event	string	Die spezifische Löschaktion (z. B. Ordner löschen, Alle Parteien aus Ordner löschen).

Pdf-Datei für einzelne Dokumente herunterladen

Vorgangs-ID:: DownloadSingleDocumentPDF

Lädt ein einzelnes Dokument aus einem Umschlag als PDF-Datei herunter.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschlag-ID	folderId	True	string	Der eindeutige Bezeichner des Umschlags, der das dokument enthält, das heruntergeladen werden soll.
Dokumentnummer	docNumber	True	string	Der Index des herunterzuladenden Dokuments ab 1.

Gibt zurück

response: binary

Signaturerinnerung senden

Vorgangs-ID:: SendSignatureReminder

Sendet eine Erinnerungsbenachrichtigung an ausstehende Empfänger eines Umschlags und fordert sie auf, die Signatur abzuschließen.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschlag-ID	folderId	True	integer	Die ID des Umschlags.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
Umschlag-ID	reminder sent	integer	Die ID des Umschlags, für den die Erinnerung gesendet wurde.

Umschlag abbrechen

Vorgangs-ID:: CancelEnvelope

Bricht einen gesendeten Umschlag ab. Empfänger können die Dokumente nicht mehr signieren.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschlag-ID	folderId	True	integer	Die ID des Umschlags, der abgebrochen werden soll.
Grund für Stornierung	reason_for_cancellation	True	string	Der Grund für die Kündigung dieses Umschlags. Dies wird im Umschlagaktivitätsverlauf aufgezeichnet.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
Umschlag-IDs abgebrochen	folders cancelled	array of integer	Die Liste der Umschlag-IDs, die erfolgreich abgebrochen wurden.

Umschlag aus Vorlage erstellen

Vorgangs-ID:: CreateEnvelopefromTemplate

Erstellt und sendet einen Umschlag mithilfe einer vorhandenen Vorlage. Empfängerdetails können angepasst werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschlagname	folderName		string	Name des(n) Dokumentordners. Wenn dieser Wert nicht angegeben wird, wird der(n) Ordnername des Dokuments mit den Vorlagennamen(n) identisch gehalten.
Vorlagen-IDs	templateIds	True	array of integer	Ein Array von Vorlagen-IDs, die Sie zum Erstellen der Dokumente für diesen Ordner verwenden möchten.
Felder	fields		object	Sie können die Feldwerte übergeben, die in den Vorlagen verwendet werden, um sie in den dokumenten vorzufüllen, die aus der Vorlage erstellt wurden. FIELD_NAME ist der Name des Felds, das in der Vorlage verwendet wird. FIELD_VALUE ist der Dokumentfeldwert.
Erweiterte E-Mail-Überprüfung	allowAdvancedEmailValidation		boolean	Überprüfen Sie die E-Mail-Adressen der Parteien, wenn sie auf "true" festgelegt sind.
Vorname	firstName	True	string	Der Vorname des Empfängers.
Nachname	lastName	True	string	Der Nachname des Empfängers.
Email Adresse	emailId	True	string	Die E-Mail-Adresse des Empfängers.
permissions	permission	True	string
Sequenz	sequence	True	integer	Verwenden Sie dieses Feld, um einem Empfänger in der Liste der Empfängerparteien eine Sequenznummer zuzuweisen. Verwenden Sie eindeutige Sequenznummern für jede Partei ab 1 wie 1,2,3,4.... Wenn eine einzelne Person mehrmals im Signaturworkflow angezeigt wird, weisen Sie bei jeder Wiederholung des Empfängers eine andere Sequenz zu.
signerAuthLevels	signerAuthLevel		string	Die Authentifizierungsebene, die ein Signierer für Überprüfungszwecke nutzt
Ist Platzhalter	isPlaceholder		boolean	Verwenden Sie dieses Feld, um die Partei zu initiieren, ein Platzhalter. Hinweis: 1. firstName, lastName, emailId parameter's value must be blank of this party. 2. Um den Platzhalter hinzuzufügen, muss ein Empfänger mit der Berechtigung "PARTY_ASSIGNER" neuquiert werden.
Empfängerrolle	partyRole		string	Verwenden Sie dieses Feld, um eine Rolle des Platzhalters zuzuweisen.
Namensänderung zulassen	allowNameChange		string	Der Wert kann entweder "true" oder "false" lauten. Verwenden Sie diesen Parameter, um zuzulassen, dass der Signierer vor abschluss des Signiervorgangs vornamens und nachname aktualisiert werden kann.
Workflowsequenz	workflowSequence		integer	Weisen Sie diesem Empfänger eine Workflowsequenznummer zu. Wenn die Anmeldesequenz aktiviert ist, erhalten die Empfänger ihre Anmeldeaufladung in aufsteigender Reihenfolge.
Host-E-Mail-ID	hostEmailId		string	E-Mail-Adresse des In-Person Administrators.
Zugangscode	userDefinedAccessCode		string	Der Parameter enthält Access Code, wenn der Wert "signerAuthLevel" für die Authentifizierung als "Benutzerdefinierter Zugriffscode" festgelegt wird. Hinweis: 1. Bei Codes wird die Groß-/Kleinschreibung nicht beachtet. 2. Das System sendet diesen Code nicht, sodass Sie diesen Code direkt für den Signierer freigeben müssen. 3. Access-Code kann Alphabete, Zahlen und die folgenden Sonderzeichen enthalten: @,&,{,},%,(,),~,\|,!,+,^.
Partei ist E-Mail-Gruppe	partyIsEmailGroup		boolean	Verwenden Sie diesen Parameter beim Erstellen einer Party als Massenvorgang. Hinweis: Wenn dieser Parameter "true" lautet, werden "firstName", "lastName" und "emailId" dieser Partei ignoriert.
E-Mail-Gruppen-ID	emailGroupId		integer	Übergeben Sie die E-Mail an die Gruppen-ID, die Sie zum Erstellen eines Massenvorgangs verwenden möchten.
Massenhinzufügen von Single Signer	allowSingleSignerInBulk		boolean	Verwenden Sie diesen Parameter, um nur einer Person die Anmeldung in einer E-Mail-Gruppe zu gestatten.
Wählcode	dialingCode		string	Verwenden Sie dieses Feld, um einem Empfänger in der Liste der Empfängerparteien eine Länder-Einwahlcodes zuzuweisen.
Handynummer	mobileNumber		string	Verwenden Sie dieses Feld, um einem Empfänger in der Liste der Empfängerparteien eine Mobiltelefonnummer zuzuweisen.
Briefumschlagkennwort	folderPassword		string	Dieses Kennwort wird vom Signierer/Autor benötigt, um das digital signierte Dokument zu öffnen. Wenn der Parameter leer gehalten wird, ist kein Kennwort erforderlich, um das digital signierte Dokument zu öffnen.
Anmeldesequenz	signInSequence		boolean	Dieses Feld wird verwendet, um zu bestimmen, ob Empfänger die Umschlagdokumente in einer Sequenz signieren. Wenn "false" lautet, erhalten alle Empfänger gleichzeitig eine Einladungs-E-Mail. Wenn "true" ist, erhält jeder Empfänger eine Einladungs-E-Mail nacheinander, nachdem der vorherige Empfänger die erforderliche Aufgabe abgeschlossen hat, z. B. das Signieren der Dokumente oder das Ausfüllen von Feldern usw.
"Persönlich aktivieren"	inPersonEnable		boolean	Dieses Feld wird verwendet, um den persönlichen Signierungsprozess zu initiieren, der auf jedem Gerät in wenigen Minuten problemlos abgeschlossen werden kann und E-Mail-basierte Signaturen bei Bedarf vermeidet. Wenn "false" lautet, erhalten alle Empfänger gleichzeitig die Einladungs-E-Mail. Wenn true, erhält der persönliche Administrator eine Einladungs-E-Mail, um den Signiervorgang für den Signierer zu initiieren.
Jetzt senden	sendNow		boolean	Wenn diese Option aktiviert ist, sendet Foxit eSign sofort einen eindeutigen Signaturlink an die E-Mail-Adresse jedes Empfängers. Deaktivieren Sie diese Option, um den Umschlag stattdessen als Entwurf zu speichern.
Signieren der Erfolgs-URL für alle Parteien	signSuccessUrlAllParties		boolean	Wenn "true" festgelegt ist, wird der Signierer nach der erfolgreichen Signierung an die url umgeleitet, die im SignSuccessUrl bereitgestellt wird. Dies gilt nur, wenn "sendNow" wahr ist.
Eingebettete Sendesitzung erstellen	createEmbeddedSendingSession		boolean	Wenn dieser Wert auf "true" festgelegt ist, wird eine eingebettete URL generiert, um die Dokumentvorbereitungsansicht von Foxit eSign zu öffnen.
Beheben von Empfängerparteien	fixRecipientParties		boolean	Wenn wahr, kann die Parteien in der eingebetteten Sendeansicht nicht für den Umschlag geändert werden, der bereits als Teil dieser Anforderung hinzugefügt wurde.
Dokumente korrigieren	fixDocuments		boolean	Wenn true, kann das eingebettete Senden die Dokumente für den Umschlag, die bereits als Teil dieser Anforderung hinzugefügt wurden, nicht ändern.
Erfolgs-URL senden	sendSuccessUrl		string	Geben Sie die absolute URL für die Zielseite ein, zu der der Signierer nach dem erfolgreichen Senden des Ordners in der eingebetteten Sendeansicht umgeleitet wird.
Url des Sendefehlers	sendErrorUrl		string	Geben Sie die absolute URL für die Zielseite ein, zu der der Signierer umgeleitet wird, wenn beim Senden des Ordners in der eingebetteten Sendeansicht ein Fehler auftritt.
Auswahloption "Signierer ausblenden"	hideSignerSelectOption		boolean	Wenn true, blendet es das Eingabefeld "Vorhandener Signierername/E-Mail" für Empfängerparteien in einer eingebetteten Sendesitzung aus.
Signieraktionen ausblenden	hideSignerActions		boolean	Wenn true, blendet es die Signiereraktionen "bearbeiten", "ändern" und "entfernen" für Empfängerparteien in einer eingebetteten Sendesitzung aus.
Absendername ausblenden	hideSenderName		boolean	Wenn true, blendet es den Namen des Absenders auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Schaltfläche "Senden" ausblenden	hideSendButton		boolean	Wenn true, blendet es die Schaltfläche "Senden" in der eingebetteten Sendesitzung aus.
Ordnername ausblenden	hideFolderName		boolean	Wenn true, blendet es den Ordnernamen in beiden eingebetteten Sitzungen aus.
Dokumentname ausblenden	hideDocumentsName		boolean	Wenn true, blendet es den Dokumentnamen in beiden eingebetteten Sitzungen aus.
Schaltfläche "Hinzufügen" ausblenden	hideAddMeButton		boolean	Wenn true, blendet es die Schaltfläche "Ich hinzufügen" auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Schaltfläche "Neue Hinzufügen" ausblenden	hideAddNewButton		boolean	Wenn true, blendet es die Schaltfläche "Neu hinzufügen" auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Schaltfläche "Gruppe hinzufügen" ausblenden	hideAddGroupButton		boolean	Wenn true, blendet es die Schaltfläche "Gruppe hinzufügen" auf Empfängerparteien in einer eingebetteten Sendesitzung aus.
Erstellen einer eingebetteten Signatursitzung	createEmbeddedSigningSession		boolean	Das Signieren des Sitzungstokens wird generiert, ohne E-Mails an die Empfänger zu senden.
Erstellen einer eingebetteten Signatursitzung für alle Parteien	createEmbeddedSigningSessionForAllParties		boolean	Bei Festlegung auf "true" wird für jeden Empfänger im Umschlag eine eingebettete Signatur-URL generiert. Wenn false, erhalten nur empfänger, die in eingebetteten Signierer-E-Mail-IDs aufgeführt sind, eine eingebettete Sitzung.
Eingebettete Signierer-E-Mail-IDs	embeddedSignersEmailIds		array of string	Ein Array von E-Mail-IDs von Empfängern, für die eine eingebettete Signatursitzung erstellt werden muss. Die E-Mail-IDs der Empfängerparteien, die in der Liste der Parteien hinzugefügt wurden.
Signiererfolgs-URL	signSuccessUrl		string	Geben Sie die absolute URL für die Signierer ein, die nach der erfolgreichen Anmeldung in der eingebetteten Signaturansicht umgeleitet werden.
Url zum Ablehnen von Signieren	signDeclineUrl		string	Geben Sie die absolute URL für die Signierer ein, an die umgeleitet werden soll, wenn die Anmeldung in der eingebetteten Signaturansicht abgelehnt wird.
Sign Later Url	signLaterUrl		string	Geben Sie die absolute URL für die Signierer ein, die weitergeleitet werden sollen, wenn Sie sich später in der eingebetteten Signaturansicht anmelden möchten.
Url des Signierfehlers	signErrorUrl		string	Geben Sie die absolute URL für die Signierer ein, die beim Signieren des Dokuments in der eingebetteten Signaturansicht zu einem Fehler weitergeleitet werden.
Nächstes Pflichtfeld ausblenden Btn	hideNextRequiredFieldBtn		boolean	Wenn dieser Wert auf "true" festgelegt ist, blendet die Navigationsschaltfläche aus, die Signierer in das nächste erforderliche Feld verschiebt.
Designfarbe	themeColor		string	Geben Sie den CSS-Wert ein, um die Designfarbe festzulegen.
Ablehnen zum Signieren ausblenden	hideDeclineToSign		boolean	Wenn dieser Wert auf "true" festgelegt ist, blendet die Option "Ablehnen zum Signieren" auf dem Signierbildschirm aus.
Weitere Aktion ausblenden	hideMoreAction		boolean	Wenn dieser Wert auf "true" festgelegt ist, blendet die Schaltfläche "Weitere Aktionen" in der Senden- und Signierungssitzung aus. Hat keine Auswirkung, wenn "Jetzt senden" auf "True" festgelegt ist.
Option "Parteien hinzufügen" ausblenden	hideAddPartiesOption		boolean	Wenn dieser Wert auf "true" festgelegt ist, wird die Option zum Hinzufügen von Parteien im Entwurfs- und Vorlagenerstellungsmodus ausgeblendet.
Sitzung läuft ab	sessionExpire		boolean	Legen Sie "true" fest, um das Ablaufen der eingebetteten Signatursitzung zu initiieren.
Ablaufdatum	expiry		integer	Erforderlich, wenn sessionExpire "true" ist. Geben Sie die Dauer in Millisekunden des Ablaufs für die eingebettete Signatursitzung ein.
Absender-E-Mail	senderEmail		string	Geben Sie E-Mails eines anderen Benutzers in Ihrem Konto ein, der zum Senden dieses Dokuments an die Empfängerparteien verwendet wird.
Jetzt senden und eingebettete Signatursitzung zulassen	allowSendNowAndEmbeddedSigningSession		boolean	Wenn "true" festgelegt ist, sendet Foxit eSign eine E-Mail-Signatureinladung an jeden Empfänger und generiert außerdem einen eingebetteten Signaturlink für Empfänger, deren E-Mail in eingebettete Signierer-E-Mails enthalten ist. Sowohl die E-Mail als auch der eingebettete Link sind gleichzeitig aktiv.
Schritt für Schritt aktivieren	enableStepByStep		boolean	So aktivieren Sie schritt-für-Schritt-Aktion in der eingebetteten Sendesitzung.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, ob der Vorgang erfolgreich war (z. B. "success").
Nachricht	message	string	Eine Beschreibung des Vorgangsergebnisses.
Eingebettete Signatursitzungen	embeddedSigningSessions	array of object	Die Liste der eingebetteten Signatursitzungen, eine pro Empfänger. Nur vorhanden, wenn createEmbeddedSigningSession true ist.
Signierer-E-Mail	embeddedSigningSessions.emailIdOfSigner	string	Die E-Mail-Adresse des Empfängers für diese eingebettete Signatursitzung.
Signaturtoken	embeddedSigningSessions.embeddedToken	string	Das eindeutige Token für die eingebettete Signatursitzung dieses Empfängers.
Signatursitzungs-URL	embeddedSigningSessions.embeddedSessionURL	string	Die URL, die für diesen Empfänger geöffnet oder eingebettet werden soll, um das Dokument zu signieren.
Eingebettetes Senden von Token	embeddedToken	string	Das Token für die eingebettete Sendesitzung. Nur vorhanden, wenn createEmbeddedSendingSession true ist.
Senden der Sitzungs-URL	embeddedSessionURL	string	Die URL zum Öffnen oder Einbetten des Umschlagautors, um den Umschlag vorzubereiten und zu senden. Nur vorhanden, wenn createEmbeddedSendingSession true ist.
ID	folder.folderId	integer	Die eindeutige ID des erstellten Umschlags. Verwenden Sie diese, um in nachfolgenden Aktionen auf den Umschlag zu verweisen.
Name	folder.folderName	string	Der Name des Umschlags.
Benutzerdefinierter Name	folder.folderCustomName	string	Der benutzerdefinierte Name, der dem Umschlag zugewiesen ist.
Password	folder.folderPassword	string	Das Kennwort, das für den Umschlag festgelegt ist, falls vorhanden.
Autor-ID	folder.folderAuthorId	integer	Die eindeutige ID des Benutzers, der den Umschlag erstellt hat.
Vorname des Autors	folder.folderAuthorFirstName	string	Der Vorname des Briefumschlagerstellers.
Nachname des Autors	folder.folderAuthorLastName	string	Der Nachname des Briefumschlagerstellers.
Email erstellen	folder.folderAuthorEmail	string	Die E-Mail-Adresse des Briefumschlagerstellers.
Autorrolle	folder.folderAuthorRole	string	Die Kontorolle des Umschlagerstellers.
Unternehmens-ID	folder.folderCompanyId	integer	Die eindeutige ID des Unternehmens, zu dem der Umschlag gehört.
Erstellungsdatum	folder.folderCreationDate	integer	Das Datum und die Uhrzeit, zu dem der Umschlag erstellt wurde, in Unix Millisekunden.
Sendedatum	folder.folderSentDate	integer	Das Datum und die Uhrzeit, zu der der Umschlag an die Empfänger gesendet wurde, in Unix Millisekunden.
Status	folder.folderStatus	string	Der aktuelle Status des Umschlags (z. B. FREIGEGEBEN, AUSGEFÜHRT, ENTWURF, ABGEBROCHEN).
Benutzerdefiniertes Feld 1	folder.custom_field1	string	Der Wert des benutzerdefinierten Felds 1, der auf dem Umschlag festgelegt ist.
Benutzerdefiniertes Feld 2	folder.custom_field2	string	Der Wert des benutzerdefinierten Felds 2, das auf dem Umschlag festgelegt ist.
Metadaten	folder.metadata	string	Alle zusätzlichen Metadaten, die dem Umschlag zugeordnet sind.
Dokument-IDs	folder.folderDocumentIds	array of integer	Die Liste der Dokument-IDs, die in diesem Umschlag enthalten sind.
Dokumente	folder.documentsList	array of object	Details zu jedem Dokument, das im Umschlag enthalten ist.
Dokument-ID	folder.documentsList.documentId	integer	Der eindeutige Bezeichner des Dokuments.
Vertrags-ID	folder.documentsList.contractId	integer	Der eindeutige Bezeichner des Vertrags, der diesem Dokument zugeordnet ist.
Unternehmens-ID	folder.documentsList.companyId	integer	Die eindeutige ID des Unternehmens, zu dem dieses Dokument gehört.
Erstellt von	folder.documentsList.contractCreatedBy	integer	Die Benutzer-ID der Person, die den Vertrag erstellt hat.
Erstellt am	folder.documentsList.contractCreatedOn	string	Das Datum, an dem der Vertrag erstellt wurde.
Vertragsart	folder.documentsList.contractType	string	Der Vertragstyp.
Dokumentstatus	folder.documentsList.contractStatus	string	Der aktuelle Signaturstatus des Dokuments (z. B. WAITING_FOR_SIGNATURE, AUSGEFÜHRT).
Bearbeitbar	folder.documentsList.editable	boolean	Gibt an, ob das Dokument bearbeitet werden kann.
Versions-ID	folder.documentsList.contractVersionId	integer	Die eindeutige ID der aktuellen Dokumentversion.
Versionsname	folder.documentsList.contractVersionName	string	Der Name der aktuellen Dokumentversion.
Versionsbeschreibung	folder.documentsList.contractVersionDesc	string	Eine Beschreibung der aktuellen Dokumentversion.
Version erstellt von	folder.documentsList.versionCreatedby	integer	Die Benutzer-ID der Person, die diese Dokumentversion erstellt hat.
Version erstellt am	folder.documentsList.versionCreatedOn	string	Das Datum, an dem diese Dokumentversion erstellt wurde.
Versionsnummer	folder.documentsList.contractVersionNumber	integer	Die Versionsnummer des Dokuments.
Transaktionsquelle	folder.documentsList.contractTransactionSource	string	Die Quelle der Vertragstransaktion.
Empfänger	folder.folderRecipientParties	array of object	Die Liste der Empfänger für diesen Umschlag, einschließlich ihrer individuellen Signaturlinks.
Empfänger-ID	folder.folderRecipientParties.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Empfänger-ID	folder.folderRecipientParties.partyDetails.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Vorname	folder.folderRecipientParties.partyDetails.firstName	string	Der Vorname des Empfängers.
Nachname	folder.folderRecipientParties.partyDetails.lastName	string	Der Nachname des Empfängers.
Email	folder.folderRecipientParties.partyDetails.emailId	string	Die E-Mail-Adresse des Empfängers.
Ist Platzhalter	folder.folderRecipientParties.partyDetails.placeholder	boolean	Gibt an, ob dieser Empfänger ein Platzhalter ist.
Adresse	folder.folderRecipientParties.partyDetails.address	string	Die Adresse des Empfängers.
Erstellungsdatum des Kontos	folder.folderRecipientParties.partyDetails.dateCreated	integer	Das Datum, an dem das Konto des Empfängers erstellt wurde, in Unix Millisekunden.
Abmelden von E-Mails	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Gibt an, ob der Empfänger E-Mail-Benachrichtigungen deaktiviert hat.
Eindeutige Party-ID	folder.folderRecipientParties.partyDetails.uniquePartyId	string	Ein eindeutiger Zeichenfolgenbezeichner für den Empfänger.
Authentifizierungsebene	folder.folderRecipientParties.partyDetails.authenticationLevel	string	Die für diesen Empfänger erforderliche Authentifizierungsstufe.
Unternehmens-ID	folder.folderRecipientParties.partyDetails.companyId	integer	Die ID des Unternehmens, zu dem der Empfänger gehört.
Benutzerrolle	folder.folderRecipientParties.partyDetails.userRole	string	Die Rolle des Empfängers innerhalb ihrer Organisation.
Abteilung	folder.folderRecipientParties.partyDetails.department	string	Die Abteilung des Empfängers.
Title	folder.folderRecipientParties.partyDetails.title	string	Die Position des Empfängers.
Aktiv	folder.folderRecipientParties.partyDetails.active	boolean	Gibt an, ob das Konto des Empfängers aktiv ist.
Wählcode	folder.folderRecipientParties.partyDetails.dialingCode	string	Die Landeswählnummer für die Telefonnummer des Empfängers.
Handynummer	folder.folderRecipientParties.partyDetails.mobileNumber	string	Die Mobiltelefonnummer des Empfängers.
Subunternehmerbeschreibung	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	Eine Beschreibung des Subunternehmers, falls zutreffend.
Subunternehmerorganisation	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	Der Name des Subunternehmers, falls zutreffend.
Hinzugefügter Subunternehmerdatum	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	Das Datum, an dem der Subunternehmer hinzugefügt wurde, in Unix Millisekunden.
Grundlage	folder.folderRecipientParties.partyDetails.source	string	Die Quelle, über die der Empfänger hinzugefügt wurde.
Wählcode	folder.folderRecipientParties.dialingCode	string	Die Landeswählnummer für die Mobiltelefonnummer des Empfängers.
Handynummer	folder.folderRecipientParties.mobileNumber	string	Die Mobiltelefonnummer des Empfängers.
Signaturtyp	folder.folderRecipientParties.signerSignatureType	string	Der Typ der für diesen Empfänger zulässigen Signatur.
Erlaubnisse	folder.folderRecipientParties.contractPermissions	string	Die diesem Empfänger erteilten Signaturberechtigungen (z. B. FILL_FIELDS_AND_SIGN).
Signierreihenfolge	folder.folderRecipientParties.partySequence	integer	Die Position dieses Empfängers in der Signierreihenfolge.
Workflowsequenz	folder.folderRecipientParties.workflowSignSequence	integer	Die Sequenznummer der Workflowsignatur für diesen Empfänger.
Umschlag-ID	folder.folderRecipientParties.envelopeId	integer	Die ID des Umschlags, zu dem dieser Empfänger gehört.
Firmen-ID der Partei	folder.folderRecipientParties.partyCompanyId	integer	Die ID des Unternehmens, zu dem dieser Empfänger gehört.
Freigabemodus	folder.folderRecipientParties.sharingMode	string	Die Methode, mit der das Dokument für diesen Empfänger freigegeben wird (z. B. E-Mail).
Signatur-URL	folder.folderRecipientParties.folderAccessURL	string	Die eindeutige Signatur-URL für diesen Empfänger. Verwenden Sie dies, um den Signierlink direkt zu teilen.
Sicherheitsmodus	folder.folderRecipientParties.securityMode	string	Der Sicherheitsmodus, der auf den Zugriff dieses Empfängers angewendet wurde.
Zusätzliche Kommentare	folder.folderRecipientParties.extraComments	string	Alle zusätzlichen Kommentare, die in der Signiereinladung für diesen Empfänger enthalten sind.
Namensänderung zulassen	folder.folderRecipientParties.allowNameChange	boolean	Gibt an, ob der Empfänger seinen Namen vor der Signatur ändern darf.
Name aktualisiert	folder.folderRecipientParties.signerNameUpdated	boolean	Gibt an, ob der Empfänger seinen Anzeigenamen aktualisiert hat.
Authentifizierungsebene	folder.folderRecipientParties.signerAuthenticationLevel	string	Die für diesen Empfänger erforderliche Authentifizierungsmethode für den Zugriff auf das Dokument.
Zugangscode	folder.folderRecipientParties.userDefinedAccessCode	string	Ein benutzerdefinierter Zugriffscode, der für diesen Empfänger zum Öffnen des Dokuments erforderlich ist.
Signatur-ID	folder.folderRecipientParties.signatureId	string	Die ID der gespeicherten Signatur, die von diesem Empfänger verwendet wird.
Empfängerrolle	folder.folderRecipientParties.partyRole	string	Die diesem Empfänger im Umschlag zugewiesene Rolle.
Feldwert für Unternehmen	folder.folderRecipientParties.companyFieldValue	string	Der Wert des Unternehmensfelds, der für diesen Empfänger bereits ausgefüllt ist.
Titelfeldwert	folder.folderRecipientParties.titleFieldValue	string	Der Wert des Titelfelds, der für diesen Empfänger bereits ausgefüllt ist.
Grund für die Signierung	folder.folderRecipientParties.reasonSigning	string	Der Grund für die Von diesem Empfänger bereitgestellte Signatur.
Pay-Feld hinzugefügt	folder.folderRecipientParties.payFieldAdded	boolean	Gibt an, ob für diesen Empfänger ein Zahlungsfeld hinzugefügt wurde.
Ist Payee	folder.folderRecipientParties.payee	boolean	Gibt an, ob dieser Empfänger ein Zahlungsempfänger ist.
Serienfeld vorhanden	folder.folderRecipientParties.recurringFieldExist	boolean	Gibt an, ob wiederkehrende Zahlungsfelder für diesen Empfänger vorhanden sind.
Drucken und Signieren abgeschlossen	folder.folderRecipientParties.printAndSignCompleted	boolean	Gibt an, ob der Empfänger eine Druck- und Signieraktion abgeschlossen hat.
Optionaler Signierer zulassen	folder.folderRecipientParties.allowOptionalSigner	boolean	Gibt an, ob dieser Empfänger als optionaler Signierer übersprungen werden kann.
Optionale Signierer	folder.folderRecipientParties.optionalSigners	string	Die Liste der optionalen Signierer, die diesem Empfänger zugeordnet sind, falls vorhanden.
Bezahlt	folder.folderRecipientParties.paid	boolean	Gibt an, ob dieser Empfänger die Zahlung abgeschlossen hat.
Zugriffs-URL des Autors	folder.folderAccessURLForAuthor	string	Die URL für den Umschlagautor, um auf das Dokument zuzugreifen.
Url des Entwurfszugriffs	folder.draftFolderAccessURL	string	Die URL für den Zugriff auf den Umschlag, während er sich im Entwurfszustand befindet.
Board Room Sign	folder.boardRoomSign	boolean	Gibt an, ob die Boardroomsignierung für diesen Umschlag aktiviert ist.
Logo einschließen	folder.includeLogo	boolean	Gibt an, ob das Firmenlogo in E-Mail-Benachrichtigungen enthalten ist.
Farbe der E-Mail-Schaltfläche	folder.email_btnBgColor	string	Die Hintergrundfarbe der Interaktiven Schaltfläche in der Signatur-E-Mail.
Textfarbe der E-Mail-Schaltfläche	folder.email_btnTxtColor	string	Die Textfarbe der Interaktiven Schaltfläche in der Signatur-E-Mail.
E-Mail-Logo	folder.emailTemplateLogo	string	Das Logobild, das in der E-Mail-Vorlage verwendet wird.
E-Mail-Vorlagen-ID	folder.emailTemplateId	integer	Die ID der E-Mail-Vorlage, die zum Signieren von Benachrichtigungen verwendet wird.
E-Mail-Kopfzeile	folder.emailHeader	string	Der benutzerdefinierte Kopfzeilentext beim Signieren von Benachrichtigungs-E-Mails.
E-Mail-Fußzeile	folder.emailFooter	string	Der benutzerdefinierte Fußzeilentext bei Signaturbenachrichtigungs-E-Mails.
Geplante Bereinigung	folder.purgeFlag	boolean	Gibt an, ob dieser Umschlag für die automatische Bereinigung geplant ist.
Startdatum löschen	folder.purgeStartDate	string	Das Datum, ab dem der Löschzeitraum beginnt.
Enddatum löschen	folder.purgeEndDate	string	Das Datum, an dem der Umschlag gelöscht wird.
Massen-ID	folder.bulkId	integer	Die ID des Massensendungsbatches, zu dem dieser Umschlag gehört, falls vorhanden.
Signierreihenfolge erzwingen	folder.enforceSignWorkflow	boolean	Gibt an, ob die Empfänger sich in der angegebenen Reihenfolge anmelden müssen.
Aktueller Workflowschritt	folder.currentWorkflowStep	integer	Der aktuelle Schritt im Signaturworkflow.
Transaktionsquelle	folder.transactionSource	string	Die Quelle, die diese Umschlagtransaktion initiiert hat.
Bearbeitbar	folder.editable	boolean	Gibt an, ob der Umschlag noch bearbeitet werden kann.
In-Person Signierung	folder.inPersonSignable	boolean	Gibt an, ob der Umschlag persönlich angemeldet werden kann.
Überschreiben von Erinnerungen	folder.overrideAccountReminders	boolean	Gibt an, ob Erinnerungseinstellungen auf Kontoebene für diesen Umschlag außer Kraft gesetzt werden.
Delegierung außer Kraft setzen	folder.overrideAccountRecipientDelegation	boolean	Gibt an, ob delegierungseinstellungen auf Kontoebene für diesen Umschlag überschrieben werden.
Delegierung zulassen	folder.allowRecipientsToDelegate	boolean	Gibt an, ob Empfänger ihre Signatur an eine andere Person delegieren dürfen.
ID	folder.envelopeId	integer	Die eindeutige ID des Umschlags. Derselbe Wert wie Umschlag-ID (folderId).
Name	folder.envelopeName	string	Der Name des Umschlags. Derselbe Wert wie Umschlagname (FolderName).
Absender-ID	folder.envelopeOriginatorId	integer	Die Benutzer-ID der Person, die den Umschlag erstellt hat.
Unternehmens-ID	folder.envelopeCompanyId	integer	Die ID des Unternehmens, zu dem der Umschlag gehört.
Datum	folder.envelopeDate	integer	Das Datum und die Uhrzeit, zu dem der Umschlag erstellt wurde, in Unix Millisekunden.
Freigegebenes Datum	folder.envelopeSharedDate	integer	Das Datum und die Uhrzeit, zu der der Umschlag für Empfänger freigegeben wurde, in Unix Millisekunden.
Status	folder.envelopeStatus	string	Der aktuelle Status des Umschlags. Derselbe Wert wie Umschlagstatus (folderStatus).
Vertrags-IDs	folder.envelopeContractIds	array of integer	Die Liste der Vertrags-IDs, die diesem Umschlag zugeordnet sind.
Partyberechtigungen	folder.envelopePartyPermissions	array of object	Die Liste der Empfänger und deren Signaturberechtigungen. Gleiche Struktur wie Empfänger.
Empfänger-ID	folder.envelopePartyPermissions.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Signatur-URL	folder.envelopePartyPermissions.folderAccessURL	string	Die eindeutige Signatur-URL für diesen Empfänger.
Erlaubnisse	folder.envelopePartyPermissions.contractPermissions	string	Die Signaturberechtigungen für diesen Empfänger.
Signierreihenfolge	folder.envelopePartyPermissions.partySequence	integer	Die Position dieses Empfängers in der Signierreihenfolge.
Authentifizierungsebene	folder.envelopeAuthenticationLevel	string	Die auf den gesamten Umschlag angewendete Authentifizierungsstufe.
Massenhinzufügen von Single Signer	folder.allowSingleSignerInBulk	boolean	Gibt an, ob ein Single Signer im Massensendungsmodus zulässig ist.
Name basiert auf Datei	folder.folderNameBasedOnFileNaming	boolean	Gibt an, ob der Umschlagname vom Dateinamen abgeleitet ist.
Dokumentname basierend auf Datei	folder.documentNameBasedOnFileNaming	boolean	Gibt an, ob der Dokumentname vom Dateinamen abgeleitet ist.
Zertifikatname basierend auf Datei	folder.certificateNameBasedOnFileNaming	boolean	Gibt an, ob der Zertifikatname vom Dateinamen abgeleitet ist.
Dateibenennung aktivieren	folder.enableFileNamingBeforeExecution	boolean	Gibt an, ob die Dateibenennung vor dem Senden des Umschlags aufgefordert wird.
Payee hinzugefügt	folder.payeeAddedd	boolean	Gibt an, ob dem Umschlag ein Zahlungsempfänger hinzugefügt wurde.
Self Signer	folder.selfSignerEnabled	boolean	Gibt an, ob der Absender auch ein Signierer auf diesem Umschlag ist.
Notar aktiviert	folder.notaryEnabled	boolean	Gibt an, ob die Notarisierung für diesen Umschlag aktiviert ist.
Eingeschränkte Sichtbarkeit	folder.limitedVisibilityFlag	boolean	Gibt an, ob die eingeschränkte Dokumentsichtbarkeit aktiviert ist.
Sichtbarkeit nach dem Signieren	folder.postSigningVisibility	boolean	Gibt an, ob Empfänger das signierte Dokument nach Abschluss anzeigen können.
Nasssignatur aktiviert	folder.wetSignatureEnabled	boolean	Gibt an, ob nasse (handschriftliche) Signaturen für diesen Umschlag aktiviert sind.
Seriendruck aktiviert	folder.mergeEnabled	boolean	Gibt an, ob das Zusammenführen von Dokumenten für diesen Umschlag aktiviert ist.

Umschlagdateien herunterladen

Vorgangs-ID:: DownloadEnvelopeFiles

Lädt die abgeschlossenen Dokumente aus einem Umschlag als Datei herunter.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Umschlag-ID	folderId	True	string	Der eindeutige Bezeichner des Umschlags, dessen Dokumente Sie herunterladen möchten.

Gibt zurück

response: binary

Umschläge in den Papierkorb verschieben

Vorgangs-ID:: MoveEnvelopestoRecycleBin

Verschiebt einen oder mehrere Umschläge in den Papierkorb. Umschläge im Papierkorb werden nicht dauerhaft gelöscht.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ordner-IDs	folderIds	True	array of integer	Ein Array von Umschlag-IDs, auf die reagiert werden soll.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, ob der Vorgang erfolgreich war.

Umschläge löschen

Vorgangs-ID:: DeleteEnvelopes

Löscht dauerhaft einen oder mehrere Umschläge.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Ordner-IDs	folderIds	True	array of integer	Ein Array von Umschlag-IDs, auf die reagiert werden soll.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, ob der Vorgang erfolgreich war.

Vorlage aus Base64 erstellen

Vorgangs-ID:: CreateTemplatefromBase64

Erstellt eine neue Vorlage mit einer base64-codierten PDF-Zeichenfolge. Verwenden Sie dies, wenn Ihre PDF-Datei bereits als Base64-Zeichenfolge in Ihrem Fluss verfügbar ist, z. B. aus einer SharePoint Datei oder OneDrive Dokument.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Vorlagenname	templateName	True	string	Der Name für die Vorlage. Muss mit der .pdf-Erweiterung enden (z. B. onboarding.pdf).
Base64-Dateizeichenfolge	base64FileString	True	string	BASE64-Zeichenfolge einer PDF-Datei für die Vorlagenerstellung. Er sollte beim Erstellen der Vorlage öffentlich zugänglich sein.
Eingabetyp	inputType	True	string	Die Eingabemethode für das Dokument. Für diese Aktion immer auf "base64" festgelegt.
Verarbeiten von Texttags	processTextTags	True	boolean	Wenn diese Option aktiviert ist, scannt Foxit eSign das Dokument nach Texttags und konvertiert sie automatisch in Signaturfelder.
Prozess-Akrofelder	processAcroFields	True	boolean	Wenn diese Option aktiviert ist, scannt Foxit eSign das Dokument nach AcroFields und konvertiert sie automatisch in Signaturfelder.
Alle freigeben	shareAll	True	boolean	Geben Sie diese Vorlage für alle Benutzer in Ihrem Konto frei.
Anzahl der Parteien	numberOfParties	True	integer	Die Anzahl der Empfängerparteien für diese Vorlage. Muss kleiner als 20 sein.
Designfarbe	themeColor		string	Ein CSS-Farbwert zum Anpassen des Designs der eingebetteten Vorlagensitzung (z. B. #42caf4).
Email erstellen	authorEmail		string	Die E-Mail-Adresse eines anderen Benutzers im Konto, die als Autor dieser Vorlage festgelegt werden soll.
Erstellen einer eingebetteten Vorlagensitzung	createEmbeddedTemplateSession		boolean	Wenn dieser Wert auf "true" festgelegt ist, wird eine eingebettete Vorlagensitzung erstellt, sodass Sie den Foxit eSign-Vorlagen-Editor direkt öffnen und Felder auf die Vorlage ziehen und ablegen können.
Umleitungs-URL	redirectURL		string	Wenn die Eingebettete Vorlagensitzung erstellt wurde, ist die URL zum Umleiten des Benutzers, nachdem er im eingebetteten Vorlagen-Editor auf "Speichern" und "Schließen" geklickt hat.
Senden-Vorlage ausblenden	hideSendTemplate		boolean	Wenn true, ist die Schaltfläche "Senden" im eingebetteten Vorlagen-Editor ausgeblendet.
Beheben von Empfängerparteien	fixRecipientParties		boolean	Wenn true, können die bereits hinzugefügten Empfängerparteien nicht im eingebetteten Vorlagen-Editor geändert werden.
Felder	Fields		object
permissions	permission	True	string
Sequenz	sequence	True	integer	Eine eindeutige Sequenznummer für diese Partei ab 1. Definiert die Signierreihenfolge, wenn die Anmeldesequenz aktiviert ist.
Empfängerrolle	partyRole	True	string	Die dieser Partei in der Vorlage zugewiesene Rolle.
Weitere Aktion ausblenden	hideMoreAction		boolean	Wenn true, wird die Schaltfläche "Weitere Aktionen" in der eingebetteten Vorlagensitzung ausgeblendet.
Freigabe für alle ausblenden	hideShareWithAll		boolean	Wenn true, ist die Option "Mit allen teilen" in der eingebetteten Vorlagensitzung ausgeblendet.
Seite hinzufügen ausblenden	hideAddParty		boolean	Wenn true, werden alle Optionen für Add-Partys in der eingebetteten Vorlagensitzung ausgeblendet.
Schaltfläche 'Ich ausblenden'	hideMeButton		boolean	Wenn true, wird die Schaltfläche "Ich" auf Empfängerparteien in der eingebetteten Vorlagensitzung ausgeblendet.
Schaltfläche "Andere ausblenden"	hideOthersButton		boolean	Ist "true", wird die Schaltfläche "Andere" in der eingebetteten Vorlagensitzung ausgeblendet.
Feldname für Empfänger ausblenden	hideFieldNameForRecipients		boolean	Bei "true" werden Feldnamen für dateneingabe- und erweiterte Felder von Empfängern ausgeblendet.
Kontrollkästchenrahmen ausblenden	hideCheckboxBorder		boolean	Wenn true, werden Kontrollkästchenrahmen in den ausgeführten Dokumenten ausgeblendet.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, ob der Vorgang erfolgreich war (z. B. "success").
Nachricht	message	string	Eine Beschreibung des Vorgangsergebnisses.
ID	template.templateId	integer	Die eindeutige ID der erstellten Vorlage. Verwenden Sie diese Vorgehensweise, um Umschläge aus dieser Vorlage zu erstellen.
Name	template.templateName	string	Der Name der Vorlage.
Description	template.templateDesc	string	Eine Beschreibung der Vorlage.
Type	template.templateType	string	Der Typ der Vorlage.
Erstellungsdatum	template.templateCreationDate	string	Das Datum, an dem die Vorlage erstellt wurde.
Datum der letzten Aktualisierung	template.templateLastUpdateDate	string	Das Datum, an dem die Vorlage zuletzt aktualisiert wurde.
Bearbeitbar	template.editable	boolean	Gibt an, ob die Vorlage bearbeitet werden kann.
Anzahl der Parteien	template.numberOfParties	integer	Die Anzahl der empfängerparteien, die in der Vorlage definiert sind.
Seiten insgesamt	template.totalPages	integer	Die Gesamtzahl der Seiten im Vorlagendokument.
Unternehmens-ID	template.companyId	integer	Die ID des Unternehmens, zu dem diese Vorlage gehört.
Für alle freigegeben	template.shareAll	boolean	Gibt an, ob diese Vorlage für alle Benutzer im Konto freigegeben wird.
Partyberechtigungen	template.templatePartyPermissions	array of object	Die Liste der Empfängerrollen und deren Berechtigungen, die in dieser Vorlage definiert sind.
Partei-ID	template.templatePartyPermissions.template_party_id	integer	Die eindeutige ID dieses Vorlagenparteieintrags.
ID	template.templatePartyPermissions.templateId	integer	Die ID der Vorlage, zu der diese Partei gehört.
Erlaubnisse	template.templatePartyPermissions.templatePermissions	string	Die Signaturberechtigungen für diese Partei (z. B. FILL_FIELDS_AND_SIGN).
Signierreihenfolge	template.templatePartyPermissions.partySequence	integer	Die Position des Signierauftrags für diese Partei.
Parteirolle	template.templatePartyPermissions.templatePartyRole	string	Der Rollenname, der dieser Partei in der Vorlage zugewiesen ist. Verwenden Sie diese Vorgehensweise beim Erstellen eines Umschlags aus der Vorlage.
Benutzer-ID	template.templateCreatedBy.partyId	integer	Die eindeutige ID des Benutzers.
Vorname	template.templateCreatedBy.firstName	string	Der Vorname des Benutzers.
Nachname	template.templateCreatedBy.lastName	string	Der Nachname des Benutzers.
Email	template.templateCreatedBy.emailId	string	Die E-Mail-Adresse des Benutzers.
Vorlagenfelder	allfields	array of object	Die Liste aller in der Vorlage definierten Signatur- und Formularfelder.
Feld-ID	allfields.fieldTagId	integer	Der eindeutige Bezeichner des Felds.
Vorlagen-ID	allfields.templateId	integer	Die ID der Vorlage, zu der dieses Feld gehört.
Unternehmens-ID	allfields.companyId	integer	Das Firmenkonto, zu dem dieses Feld gehört.
Feldtyp	allfields.fieldType	string	Der Typ des Felds (z. B. Zeichenfeld, Initialfeld, Textfeld, Datumsfeld, Kontrollkästchenfeld, gesichertes Feld, Anlagefeld).
Seitennummer	allfields.documentPageNumber	integer	Die Seitenzahl des Dokuments, in dem dieses Feld platziert wird.
Verantwortliche Partei	allfields.partyResponsible	integer	Die Parteisequenznummer, die für das Ausfüllen dieses Felds verantwortlich ist.
Partysequenz	allfields.partyResponsibleSequence	integer	Die Sequenzposition der verantwortlichen Partei.
Felddokument-ID	allfields.docFieldId	string	Der Bezeichner auf Dokumentebene für dieses Feld.
Ist abhängig	allfields.dependent	boolean	Gibt an, ob die Sichtbarkeit dieses Felds vom Wert eines anderen Felds abhängt.
Aktivierreihenfolge	allfields.tabOrder	integer	Die Aktivierreihenfolge für die Navigation zwischen Feldern.
Erforderlich	allfields.required	boolean	Gibt an, ob dieses Feld ausgefüllt werden muss, bevor das Dokument signiert werden kann.
Name des benutzerdefinierten Felds	allfields.customFieldName	string	Diesem Feld zugewiesener benutzerdefinierter Name.
Alle freigeben	allfields.shareAll	boolean	Gibt an, ob dieses Feld für alle Benutzer freigegeben ist.
Bearbeiten zulassen	allfields.allowEdit	boolean	Gibt an, ob dieses Feld vom Empfänger bearbeitet werden kann.
Textfeldname	allfields.textfieldName	string	Die Beschriftung des Textfelds (zutreffend, wenn fieldType "textfield" ist).
Wert	allfields.value	string	Der vorgefüllte oder eingegebene Wert des Felds.
Schriftgröße	allfields.fontSize	integer	Der Schriftgrad, der für Text in diesem Feld verwendet wird.
Schriftfarbe	allfields.fontColor	string	Die Schriftfarbe, die für Text in diesem Feld verwendet wird (z. B. #0000000).
Nur Leseberechtigung	allfields.readOnly	boolean	Gibt an, ob das Feld schreibgeschützt ist und vom Empfänger nicht bearbeitet werden kann.
Mehrzeiliges	allfields.multiLine	boolean	Gibt an, ob das Textfeld mehrere Eingabezeilen akzeptiert (zutreffend, wenn fieldType "textfield" ist).
Zeichenlimit	allfields.characterLimit	integer	Die maximale Anzahl zulässiger Zeichen im Feld (gilt, wenn fieldType "textfield" ist).
Name des Datumsfelds	allfields.datefieldName	string	Die Beschriftung des Datumsfelds (zutreffend, wenn fieldType "datefield" ist).
Datumsformat	allfields.dateFormat	string	Das datumsformat, das von diesem Feld verwendet wird (z. B. MM/TT/JJJJ) (anwendbar, wenn fieldType "datefield" ist).
Kontrollkästchenname	allfields.cbname	string	Die Beschriftung des Kontrollkästchenfelds (zutreffend, wenn fieldType "checkboxfield" ist).
Kontrollkästchengruppe	allfields.cbgroup	string	Der Gruppenname für dieses Kontrollkästchen (gilt, wenn fieldType "checkboxfield" ist).
Geprüft	allfields.checked	boolean	Gibt an, ob das Kontrollkästchen standardmäßig aktiviert ist (zutreffend, wenn fieldType "checkboxfield" ist).
Name des gesicherten Felds	allfields.securedfieldName	string	Die Bezeichnung des gesicherten Felds (zutreffend, wenn fieldType "securedfield" ist).
Anzuzeigende Zeichen	allfields.charToDisplay	integer	Die Anzahl der nicht maskierten Zeichen, die am Ende eines gesicherten Feldwerts angezeigt werden sollen (gilt, wenn fieldType "gesichertes Feld" ist).
Signatur-ID	allfields.signatureId	string	Die ID der Signatur, die auf dieses Zeichenfeld angewendet wird (gilt, wenn fieldType "signfield" ist).
Anfangsbild	allfields.initialImage	string	Die Bilddaten für die Initialen, die auf dieses Feld angewendet werden (gilt, wenn fieldType "initialfield" ist).
Name des Anlagenfelds	allfields.attachmentfieldName	string	Der Name des Anlagenfelds (gilt, wenn fieldType "attachmentfield" ist).
Anlagenbeschreibung	allfields.attachmentfieldDescription	string	Eine Beschreibung des Anfügens (zutreffend, wenn fieldType "attachmentfield" ist).

Vorlage aus URL erstellen

Vorgangs-ID:: CreateTemplatefromURL

Erstellt eine neue Vorlage mithilfe einer öffentlich zugänglichen PDF-URL.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Vorlagenname	templateName	True	string	Der Name für die Vorlage. Muss mit der .pdf-Erweiterung enden (z. B. onboarding.pdf).
Vorlagen-URL	templateUrl	True	string	Die öffentlich zugängliche URL des PDF-Dokuments, das als Vorlage verwendet werden soll.
Eingabetyp	inputType	True	string	Die Eingabemethode für das Dokument. Legen Sie für diese Aktion immer auf "URL" fest.
Verarbeiten von Texttags	processTextTags	True	boolean	Wenn diese Option aktiviert ist, scannt Foxit eSign das Dokument nach Texttags und konvertiert sie automatisch in Signaturfelder.
Prozess-Akrofelder	processAcroFields	True	boolean	Wenn diese Option aktiviert ist, scannt Foxit eSign das Dokument nach AcroFields und konvertiert sie automatisch in Signaturfelder.
Alle freigeben	shareAll	True	boolean	Geben Sie diese Vorlage für alle Benutzer in Ihrem Konto frei.
Anzahl der Parteien	numberOfParties	True	integer	Fügen Sie die Anzahl der Parteien in der Vorlage hinzu. Die Werte dieses Parameters sollten kleiner als 20 sein.
Designfarbe	themeColor		string	Geben Sie einen CSS-Wert für eine Farbe ein, um das Design von createEmbeddedTemplateSession zu ändern.
Email erstellen	authorEmail		string	Geben Sie eine E-Mail eines anderen Benutzers in ein Konto ein, das als Autor für diese Vorlage verwendet wird.
Erstellen einer eingebetteten Vorlagensitzung	createEmbeddedTemplateSession		boolean	Wenn diese Einstellung auf "true" festgelegt ist, wird eine eingebettete Vorlagensitzung zum direkten Öffnen der Foxit eSign-Vorlage zum Vorbereiten der Ansicht verwendet. Das Ziehen und Ablegen verschiedener Felder in der Vorlage ist verfügbar.
Umleitungs-URL	redirectURL		string	Wenn createEmbeddedTemplateSession "true" ist, kann die absolute URL für die Startseite auf einer beliebigen Website/Anwendung eingegeben werden, zu der der Benutzer nach dem Klicken auf "Speichern und Schließen" in der eingebetteten Vorlagenansicht umgeleitet wird.
Senden-Vorlage ausblenden	hideSendTemplate		boolean	Wenn true, blendet es die Schaltfläche "Senden" in einer eingebetteten Vorlagenansicht aus.
Beheben von Empfängerparteien	fixRecipientParties		boolean	Wenn true, kann die Parteien in der eingebetteten Vorlagenansicht nicht für den Umschlag geändert werden, der bereits hinzugefügt wurde.
Felder	Fields		object
permissions	permission	True	string
Sequenz	sequence	True	integer	Eine eindeutige Sequenznummer für diese Partei ab 1. Definiert die Signierreihenfolge, wenn die Anmeldesequenz aktiviert ist.
Empfängerrolle	partyRole	True	string	Die dieser Partei in der Vorlage zugewiesene Rolle.
Weitere Aktion ausblenden	hideMoreAction		boolean	Wenn "true", wird die Schaltfläche "Weitere Aktionen" in der Vorlagensitzung ausgeblendet.
Freigabe für alle ausblenden	hideShareWithAll		boolean	Wenn true, wird die Option "Mit allen teilen" in der Vorlagensitzung ausgeblendet.
Seite hinzufügen ausblenden	hideAddParty		boolean	Wenn true, blendet es alle Optionen der Add-Party in einer eingebetteten Vorlagensitzung aus.
Schaltfläche 'Ich ausblenden'	hideMeButton		boolean	Wenn true, blendet es die Schaltfläche "Ich" auf Empfängerparteien in einer eingebetteten Vorlagensitzung aus.
Schaltfläche "Andere ausblenden"	hideOthersButton		boolean	Wenn true, wird die Schaltfläche "Andere" auf Empfängerparteien in einer eingebetteten Vorlagensitzung ausgeblendet.
Vorhandene Kontaktauswahloption ausblenden	hideExistingContactSelectOption		boolean	Wenn true, blendet es das Eingabefeld "Vorhandenen Kontakt suchen und hinzufügen" für Empfängerparteien in einer eingebetteten Vorlagensitzung aus.
Feldname für Empfänger ausblenden	hideFieldNameForRecipients		boolean	Feldnamen für Empfänger für Dateneingabefelder und erweiterte Felder ausblenden. (Außer Optionsfeld, Kontrollkästchen, Bild und Link).
Kontrollkästchenrahmen ausblenden	hideCheckboxBorder		boolean	Rahmen des Kontrollkästchens werden in den ausgeführten Dokumenten ausgeblendet.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, ob der Vorgang erfolgreich war (z. B. "success").
Nachricht	message	string	Eine Beschreibung des Vorgangsergebnisses.
ID	template.templateId	integer	Die eindeutige ID der erstellten Vorlage. Verwenden Sie diese Vorgehensweise, um Umschläge aus dieser Vorlage zu erstellen.
Name	template.templateName	string	Der Name der Vorlage.
Description	template.templateDesc	string	Eine Beschreibung der Vorlage.
Type	template.templateType	string	Der Typ der Vorlage.
Erstellungsdatum	template.templateCreationDate	string	Das Datum, an dem die Vorlage erstellt wurde.
Datum der letzten Aktualisierung	template.templateLastUpdateDate	string	Das Datum, an dem die Vorlage zuletzt aktualisiert wurde.
Bearbeitbar	template.editable	boolean	Gibt an, ob die Vorlage bearbeitet werden kann.
Anzahl der Parteien	template.numberOfParties	integer	Die Anzahl der empfängerparteien, die in der Vorlage definiert sind.
Seiten insgesamt	template.totalPages	integer	Die Gesamtzahl der Seiten im Vorlagendokument.
Unternehmens-ID	template.companyId	integer	Die ID des Unternehmens, zu dem diese Vorlage gehört.
Für alle freigegeben	template.shareAll	boolean	Gibt an, ob diese Vorlage für alle Benutzer im Konto freigegeben wird.
Benutzerdefiniertes Namensmuster	template.templateCustomName	string	Das benutzerdefinierte Namensmuster, das auf umschläge angewendet wird, die aus dieser Vorlage erstellt wurden.
Partyberechtigungen	template.templatePartyPermissions	array of object	Die Liste der Empfängerrollen und deren Berechtigungen, die in dieser Vorlage definiert sind.
Partei-ID	template.templatePartyPermissions.template_party_id	integer	Die eindeutige ID dieses Vorlagenparteieintrags.
ID	template.templatePartyPermissions.templateId	integer	Die ID der Vorlage, zu der diese Partei gehört.
Erlaubnisse	template.templatePartyPermissions.templatePermissions	string	Die Signaturberechtigungen für diese Partei (z. B. FILL_FIELDS_AND_SIGN).
Signierreihenfolge	template.templatePartyPermissions.partySequence	integer	Die Position des Signierauftrags für diese Partei.
Parteirolle	template.templatePartyPermissions.templatePartyRole	string	Der Rollenname, der dieser Partei in der Vorlage zugewiesen ist. Verwenden Sie diese Vorgehensweise beim Erstellen eines Umschlags aus der Vorlage.
Partei-ID	template.templatePartyPermissions.partyId	integer	Die ID der Partei, die dieser Rolle zugewiesen ist, wenn sie bereits zugewiesen ist.
Benutzer-ID	template.templateCreatedBy.partyId	integer	Die eindeutige ID des Benutzers.
Vorname	template.templateCreatedBy.firstName	string	Der Vorname des Benutzers.
Nachname	template.templateCreatedBy.lastName	string	Der Nachname des Benutzers.
Email	template.templateCreatedBy.emailId	string	Die E-Mail-Adresse des Benutzers.
Unternehmens-ID	template.templateCreatedBy.companyId	integer	Die ID des Unternehmens, zu dem der Benutzer gehört.
Benutzerrolle	template.templateCreatedBy.userRole	string	Die Rolle des Benutzers innerhalb seiner Organisation.
Aktiv	template.templateCreatedBy.active	boolean	Gibt an, ob das Benutzerkonto aktiv ist.
Benutzer-ID	template.templateLastUpdatedBy.partyId	integer	Die eindeutige ID des Benutzers.
Vorname	template.templateLastUpdatedBy.firstName	string	Der Vorname des Benutzers.
Nachname	template.templateLastUpdatedBy.lastName	string	Der Nachname des Benutzers.
Email	template.templateLastUpdatedBy.emailId	string	Die E-Mail-Adresse des Benutzers.
Unternehmens-ID	template.templateLastUpdatedBy.companyId	integer	Die ID des Unternehmens, zu dem der Benutzer gehört.
Benutzerrolle	template.templateLastUpdatedBy.userRole	string	Die Rolle des Benutzers innerhalb seiner Organisation.
Aktiv	template.templateLastUpdatedBy.active	boolean	Gibt an, ob das Benutzerkonto aktiv ist.
Vorlagenfelder	allfields	array of object	Die Liste aller in der Vorlage definierten Signatur- und Formularfelder.
Feld-ID	allfields.fieldTagId	integer	Der eindeutige Bezeichner des Felds.
Vorlagen-ID	allfields.templateId	integer	Die ID der Vorlage, zu der dieses Feld gehört.
Unternehmens-ID	allfields.companyId	integer	Das Firmenkonto, zu dem dieses Feld gehört.
Feldtyp	allfields.fieldType	string	Der Typ des Felds (z. B. Zeichenfeld, Initialfeld, Textfeld, Datumsfeld, Kontrollkästchenfeld, gesichertes Feld, Anlagefeld).
Seitennummer	allfields.documentPageNumber	integer	Die Seitenzahl des Dokuments, in dem dieses Feld platziert wird.
Verantwortliche Partei	allfields.partyResponsible	integer	Die Parteisequenznummer, die für das Ausfüllen dieses Felds verantwortlich ist.
Partysequenz	allfields.partyResponsibleSequence	integer	Die Sequenzposition der verantwortlichen Partei.
Felddokument-ID	allfields.docFieldId	string	Der Bezeichner auf Dokumentebene für dieses Feld.
Ist abhängig	allfields.dependent	boolean	Gibt an, ob die Sichtbarkeit dieses Felds vom Wert eines anderen Felds abhängt.
Aktivierreihenfolge	allfields.tabOrder	integer	Die Aktivierreihenfolge für die Navigation zwischen Feldern.
Erforderlich	allfields.required	boolean	Gibt an, ob dieses Feld ausgefüllt werden muss, bevor das Dokument signiert werden kann.
Name des benutzerdefinierten Felds	allfields.customFieldName	string	Diesem Feld zugewiesener benutzerdefinierter Name.
Alle freigeben	allfields.shareAll	boolean	Gibt an, ob dieses Feld für alle Benutzer freigegeben ist.
Bearbeiten zulassen	allfields.allowEdit	boolean	Gibt an, ob dieses Feld vom Empfänger bearbeitet werden kann.
Textfeldname	allfields.textfieldName	string	Die Beschriftung des Textfelds (zutreffend, wenn fieldType "textfield" ist).
Wert	allfields.value	string	Der vorgefüllte oder eingegebene Wert des Felds.
Schriftgröße	allfields.fontSize	integer	Der Schriftgrad, der für Text in diesem Feld verwendet wird.
Schriftfarbe	allfields.fontColor	string	Die Schriftfarbe, die für Text in diesem Feld verwendet wird (z. B. #0000000).
Nur Leseberechtigung	allfields.readOnly	boolean	Gibt an, ob das Feld schreibgeschützt ist und vom Empfänger nicht bearbeitet werden kann.
Mehrzeiliges	allfields.multiLine	boolean	Gibt an, ob das Textfeld mehrere Eingabezeilen akzeptiert (zutreffend, wenn fieldType "textfield" ist).
Zeichenlimit	allfields.characterLimit	integer	Die maximale Anzahl zulässiger Zeichen im Feld (gilt, wenn fieldType "textfield" ist).
Name des Datumsfelds	allfields.datefieldName	string	Die Beschriftung des Datumsfelds (zutreffend, wenn fieldType "datefield" ist).
Datumsformat	allfields.dateFormat	string	Das datumsformat, das von diesem Feld verwendet wird (z. B. MM/TT/JJJJ) (anwendbar, wenn fieldType "datefield" ist).
Kontrollkästchenname	allfields.cbname	string	Die Beschriftung des Kontrollkästchenfelds (zutreffend, wenn fieldType "checkboxfield" ist).
Kontrollkästchengruppe	allfields.cbgroup	string	Der Gruppenname für dieses Kontrollkästchen (gilt, wenn fieldType "checkboxfield" ist).
Geprüft	allfields.checked	boolean	Gibt an, ob das Kontrollkästchen standardmäßig aktiviert ist (zutreffend, wenn fieldType "checkboxfield" ist).
Name des gesicherten Felds	allfields.securedfieldName	string	Die Bezeichnung des gesicherten Felds (zutreffend, wenn fieldType "securedfield" ist).
Anzuzeigende Zeichen	allfields.charToDisplay	integer	Die Anzahl der nicht maskierten Zeichen, die am Ende eines gesicherten Feldwerts angezeigt werden sollen (gilt, wenn fieldType "gesichertes Feld" ist).
Signatur-ID	allfields.signatureId	string	Die ID der Signatur, die auf dieses Zeichenfeld angewendet wird (gilt, wenn fieldType "signfield" ist).
Anfangsbild	allfields.initialImage	string	Die Bilddaten für die Initialen, die auf dieses Feld angewendet werden (gilt, wenn fieldType "initialfield" ist).
Name des Anlagenfelds	allfields.attachmentfieldName	string	Der Name des Anlagenfelds (gilt, wenn fieldType "attachmentfield" ist).
Anlagenbeschreibung	allfields.attachmentfieldDescription	string	Eine Beschreibung des Anfügens (zutreffend, wenn fieldType "attachmentfield" ist).

Vorlagen nach Vorlagen-IDs abrufen

Vorgangs-ID:: GetTemplatesbyTemplateIds

Ruft Details für eine oder mehrere Vorlagen anhand ihrer IDs ab.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Vorlagen-IDs	templateIds	True	array of integer	Ein Array von Vorlagen-IDs, die abgerufen werden sollen.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
Gesamtvorlagen	total_templates	integer	Die Gesamtzahl der zurückgegebenen Vorlagen.
Vorlagenliste	templateIdList	object	Eine Zuordnung von Vorlagendaten, die anhand der Vorlagen-ID schlüsseliert sind. Jeder Eintrag enthält die Vorlagendetails und die zugehörigen Felder.

Vorlagendetails abrufen

Vorgangs-ID:: GetTemplateDetails

Ruft die vollständigen Details einer bestimmten Vorlage ab, einschließlich der Felder und Empfänger.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Vorlagen-ID	templateId	True	string	Der eindeutige Bezeichner der abzurufenden Vorlage.

Gibt zurück

Name	Pfad	Typ	Beschreibung
Result	result	string	Gibt an, dass die Anforderung erfolgreich war.
ID	template.templateId	integer	Der eindeutige Bezeichner der Vorlage.
Name	template.templateName	string	Der Name der Vorlage.
Description	template.templateDesc	string	Eine Beschreibung der Vorlage.
Type	template.templateType	string	Der Typ der Vorlage.
Erstellungsdatum	template.templateCreationDate	integer	Das Datum, an dem die Vorlage erstellt wurde, in Unix Millisekunden.
Datum der letzten Aktualisierung	template.templateLastUpdateDate	integer	Das Datum, an dem die Vorlage zuletzt aktualisiert wurde, in Unix Millisekunden.
Bearbeitbar	template.editable	boolean	Gibt an, ob die Vorlage bearbeitet werden kann.
Anzahl der Parteien	template.numberOfParties	integer	Die Anzahl der in der Vorlage definierten Signaturparteien.
Seiten insgesamt	template.totalPages	integer	Die Gesamtzahl der Seiten im Vorlagendokument.
Unternehmens-ID	template.companyId	integer	Das Firmenkonto, zu dem die Vorlage gehört.
Für alle freigeben	template.shareAll	boolean	Gibt an, ob die Vorlage für alle Benutzer im Konto freigegeben wird.
Benutzerdefiniertes Namensmuster	template.templateCustomName	string	Das benutzerdefinierte Namensmuster, das auf umschläge angewendet wird, die aus dieser Vorlage erstellt wurden.
Partyberechtigungen	template.templatePartyPermissions	array of object	Die Liste der Empfängerrollen und deren Signaturberechtigungen, die in dieser Vorlage definiert sind.
Partei-ID	template.templatePartyPermissions.template_party_id	integer	Die eindeutige ID dieses Vorlagenparteieintrags.
ID	template.templatePartyPermissions.templateId	integer	Die ID der Vorlage, zu der diese Partei gehört.
Erlaubnisse	template.templatePartyPermissions.templatePermissions	string	Die Signaturberechtigungen für diese Partei (z. B. FILL_FIELDS_AND_SIGN).
Signierreihenfolge	template.templatePartyPermissions.partySequence	integer	Die Position des Signierauftrags für diese Partei.
Parteirolle	template.templatePartyPermissions.templatePartyRole	string	Der Rollenname, der dieser Partei zugewiesen ist. Verwenden Sie diesen Wert beim Erstellen eines Umschlags aus dieser Vorlage.
Partei-ID	template.templatePartyPermissions.partyId	integer	Die ID der Partei, die dieser Rolle zugewiesen ist, wenn sie bereits zugewiesen ist.
Partei-ID	template.templateCreatedBy.partyId	integer	Der eindeutige Bezeichner des Benutzers.
Vorname	template.templateCreatedBy.firstName	string	Der Vorname des Benutzers.
Nachname	template.templateCreatedBy.lastName	string	Der Nachname des Benutzers.
Email	template.templateCreatedBy.emailId	string	Die E-Mail-Adresse des Benutzers.
Abteilung	template.templateCreatedBy.department	string	Die Abteilung des Benutzers.
Title	template.templateCreatedBy.title	string	Die Position des Benutzers.
Aktiv	template.templateCreatedBy.active	boolean	Gibt an, ob das Benutzerkonto aktiv ist.
Partei-ID	template.templateLastUpdatedBy.partyId	integer	Der eindeutige Bezeichner des Benutzers.
Vorname	template.templateLastUpdatedBy.firstName	string	Der Vorname des Benutzers.
Nachname	template.templateLastUpdatedBy.lastName	string	Der Nachname des Benutzers.
Email	template.templateLastUpdatedBy.emailId	string	Die E-Mail-Adresse des Benutzers.
Abteilung	template.templateLastUpdatedBy.department	string	Die Abteilung des Benutzers.
Title	template.templateLastUpdatedBy.title	string	Die Position des Benutzers.
Aktiv	template.templateLastUpdatedBy.active	boolean	Gibt an, ob das Benutzerkonto aktiv ist.
Alle Felder	allfields	array of object	Die Liste aller in dieser Vorlage definierten Felder.
Feldtag-ID	allfields.fieldTagId	integer	Der eindeutige Bezeichner des Felds.
Vorlagen-ID	allfields.templateId	integer	Die ID der Vorlage, zu der dieses Feld gehört.
Unternehmens-ID	allfields.companyId	integer	Das Firmenkonto, zu dem dieses Feld gehört.
Feldtyp	allfields.fieldType	string	Der Typ des Felds (z. B. Zeichenfeld, Initialfeld, Textfeld, Datumsfeld, Kontrollkästchenfeld, gesichertes Feld, Anlagefeld).
Seitennummer	allfields.documentPageNumber	integer	Die Seitenzahl des Dokuments, in dem dieses Feld platziert wird.
Verantwortlicher Partei	allfields.partyResponsible	integer	Die Parteisequenznummer, die für das Abschließen dieses Felds verantwortlich ist.
Partysequenz	allfields.partyResponsibleSequence	integer	Die Sequenzposition der verantwortlichen Partei.
Doc-Feld-ID	allfields.docFieldId	string	Der Bezeichner dieses Felds innerhalb des Dokuments.
Abhängig	allfields.dependent	boolean	Gibt an, ob die Sichtbarkeit dieses Felds vom Wert eines anderen Felds abhängt.
Aktivierreihenfolge	allfields.tabOrder	integer	Die Aktivierreihenfolge für die Navigation zwischen Feldern.
Erforderlich	allfields.required	boolean	Gibt an, ob dieses Feld abgeschlossen werden muss, bevor das Dokument signiert werden kann.
Name des benutzerdefinierten Felds	allfields.customFieldName	string	Diesem Feld zugewiesener benutzerdefinierter Name.
Alle freigeben	allfields.shareAll	boolean	Gibt an, ob dieses Feld für alle Benutzer freigegeben ist.
Bearbeiten zulassen	allfields.allowEdit	boolean	Gibt an, ob dieses Feld vom Empfänger bearbeitet werden kann.
Textfeldname	allfields.textfieldName	string	Die Beschriftung des Textfelds (zutreffend, wenn fieldType "textfield" ist).
Wert	allfields.value	string	Der vorgefüllte oder eingegebene Wert des Felds.
Schriftgröße	allfields.fontSize	integer	Der Schriftgrad, der für Text in diesem Feld verwendet wird.
Schriftfarbe	allfields.fontColor	string	Die Schriftfarbe, die für Text in diesem Feld verwendet wird (z. B. #0000000).
Nur Leseberechtigung	allfields.readOnly	boolean	Gibt an, ob das Feld schreibgeschützt ist und vom Empfänger nicht bearbeitet werden kann.
Mehrzeiliges	allfields.multiLine	boolean	Gibt an, ob das Textfeld mehrere Eingabezeilen akzeptiert (zutreffend, wenn fieldType "textfield" ist).
Zeichenlimit	allfields.characterLimit	integer	Die maximale Anzahl zulässiger Zeichen im Feld (gilt, wenn fieldType "textfield" ist).
Name des Datumsfelds	allfields.datefieldName	string	Die Beschriftung des Datumsfelds (zutreffend, wenn fieldType "datefield" ist).
Datumsformat	allfields.dateFormat	string	Das datumsformat, das von diesem Feld verwendet wird (z. B. MM/TT/JJJJ) (anwendbar, wenn fieldType "datefield" ist).
Kontrollkästchenname	allfields.cbname	string	Die Beschriftung des Kontrollkästchenfelds (zutreffend, wenn fieldType "checkboxfield" ist).
Kontrollkästchengruppe	allfields.cbgroup	string	Der Gruppenname für dieses Kontrollkästchen, der verwendet wird, wenn mehrere Kontrollkästchen verknüpft sind (zutreffend, wenn fieldType "checkboxfield" ist).
Geprüft	allfields.checked	boolean	Gibt an, ob das Kontrollkästchen standardmäßig aktiviert ist (zutreffend, wenn fieldType "checkboxfield" ist).
Name des gesicherten Felds	allfields.securedfieldName	string	Die Bezeichnung des gesicherten Felds (zutreffend, wenn fieldType "securedfield" ist).
Anzuzeigende Zeichen	allfields.charToDisplay	integer	Die Anzahl der nicht maskierten Zeichen, die am Ende eines gesicherten Feldwerts angezeigt werden sollen (gilt, wenn fieldType "gesichertes Feld" ist).
Signatur-ID	allfields.signatureId	string	Die ID der Signatur, die auf dieses Zeichenfeld angewendet wird (gilt, wenn fieldType "signfield" ist).
Anfangsbild	allfields.initialImage	string	Die Bilddaten für die Initialen, die auf dieses Feld angewendet werden (gilt, wenn fieldType "initialfield" ist).
Name des Anlagenfelds	allfields.attachmentfieldName	string	Der Name des Anlagenfelds (gilt, wenn fieldType "attachmentfield" ist).
Anlagenbeschreibung	allfields.attachmentfieldDescription	string	Eine Beschreibung des Anfügens (zutreffend, wenn fieldType "attachmentfield" ist).

Webhook-Trigger kündigen

Vorgangs-ID:: DeleteTriggerWebhookChannel

Löscht ein aktives Webhook-Kanalabonnement anhand seiner Kanal-ID. Verwenden Sie diese Aktion, um Webhook-Abonnements zu bereinigen, die nicht mehr benötigt werden.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kanal-ID	channelId	True	integer	Die ID des zu löschenden Webhook-Kanals.

Trigger

Wenn ein Umschlag abgebrochen wird	Wird ausgelöst, wenn ein Umschlag von einem Empfänger oder absender abgebrochen wird.
Wenn ein Umschlag angezeigt wird	Wird ausgelöst, wenn ein Empfänger den Umschlag öffnet und anzeigt.
Wenn ein Umschlag gelöscht wird	Löst aus, wenn ein Umschlag gelöscht wird.
Wenn ein Umschlag gesendet wird	Wird ausgelöst, wenn ein Umschlag an Empfänger gesendet wird. Dieses Ereignis wird nur ausgelöst, wenn die Webhook-Ebene auf "Konto" festgelegt ist.
Wenn ein Umschlag signiert ist	Wird ausgelöst, wenn ein Empfänger den Umschlag signiert.
Wenn ein Umschlag vollständig ausgeführt wird	Wird ausgelöst, wenn alle Empfänger signiert sind und der Umschlag vollständig ausgeführt wird.

Wenn ein Umschlag abgebrochen wird

Vorgangs-ID:: TriggerEnvelopeCancelled

Wird ausgelöst, wenn ein Umschlag von einem Empfänger oder absender abgebrochen wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kanalname	channelName	True	string	Ein Name, um dieses Webhook-Abonnement in Ihrem Konto zu identifizieren.
Webhook-Ebene	webhookLevel	True	string	Konto: wird für alle Umschläge (Web und API) ausgelöst. API-App: wird nur für Umschläge ausgelöst, die über die API erstellt wurden.
Geheimer Webhook-Schlüssel	webhookSecret		string	Optional. Foxit eSign signiert jede Webhook-Nutzlast mit HMAC-SHA-256 mit diesem Geheimschlüssel zur Überprüfung.

Gibt zurück

Die ereignisdaten, die von Foxit eSign empfangen werden, wenn ein Webhook-Ereignis ausgelöst wird.

WebhookEventPayload: WebhookEventPayload

Wenn ein Umschlag angezeigt wird

Vorgangs-ID:: TriggerEnvelopeViewed

Wird ausgelöst, wenn ein Empfänger den Umschlag öffnet und anzeigt.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kanalname	channelName	True	string	Ein Name, um dieses Webhook-Abonnement in Ihrem Konto zu identifizieren.
Webhook-Ebene	webhookLevel	True	string	Konto: wird für alle Umschläge (Web und API) ausgelöst. API-App: wird nur für Umschläge ausgelöst, die über die API erstellt wurden.
Geheimer Webhook-Schlüssel	webhookSecret		string	Optional. Foxit eSign signiert jede Webhook-Nutzlast mit HMAC-SHA-256 mit diesem Geheimschlüssel zur Überprüfung.

Gibt zurück

Die ereignisdaten, die von Foxit eSign empfangen werden, wenn ein Webhook-Ereignis ausgelöst wird.

WebhookEventPayload: WebhookEventPayload

Wenn ein Umschlag gelöscht wird

Vorgangs-ID:: TriggerEnvelopeDeleted

Löst aus, wenn ein Umschlag gelöscht wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kanalname	channelName	True	string	Ein Name, um dieses Webhook-Abonnement in Ihrem Konto zu identifizieren.
Webhook-Ebene	webhookLevel	True	string	Konto: wird für alle Umschläge (Web und API) ausgelöst. API-App: wird nur für Umschläge ausgelöst, die über die API erstellt wurden.
Geheimer Webhook-Schlüssel	webhookSecret		string	Optional. Foxit eSign signiert jede Webhook-Nutzlast mit HMAC-SHA-256 mit diesem Geheimschlüssel zur Überprüfung.

Gibt zurück

Die ereignisdaten, die von Foxit eSign empfangen werden, wenn ein Webhook-Ereignis ausgelöst wird.

WebhookEventPayload: WebhookEventPayload

Wenn ein Umschlag gesendet wird

Vorgangs-ID:: TriggerEnvelopeSent

Wird ausgelöst, wenn ein Umschlag an Empfänger gesendet wird. Dieses Ereignis wird nur ausgelöst, wenn die Webhook-Ebene auf "Konto" festgelegt ist.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kanalname	channelName	True	string	Ein Name, um dieses Webhook-Abonnement in Ihrem Konto zu identifizieren.
Webhook-Ebene	webhookLevel	True	string	Konto: Feuer für Umschläge, die über das Web oder die API gesendet werden. API-App: wird nur für Umschläge ausgelöst, die über die API erstellt wurden. Das folder_sent-Ereignis wird nur auf Kontoebene ausgelöst.
Geheimer Webhook-Schlüssel	webhookSecret		string	Optional. Foxit eSign signiert jede Webhook-Nutzlast mit HMAC-SHA-256 mit diesem Geheimschlüssel zur Überprüfung.

Gibt zurück

Die ereignisdaten, die von Foxit eSign empfangen werden, wenn ein Webhook-Ereignis ausgelöst wird.

WebhookEventPayload: WebhookEventPayload

Wenn ein Umschlag signiert ist

Vorgangs-ID:: TriggerEnvelopeSigned

Wird ausgelöst, wenn ein Empfänger den Umschlag signiert.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kanalname	channelName	True	string	Ein Name, um dieses Webhook-Abonnement in Ihrem Konto zu identifizieren.
Webhook-Ebene	webhookLevel	True	string	Konto: wird für alle Umschläge (Web und API) ausgelöst. API-App: wird nur für Umschläge ausgelöst, die über die API erstellt wurden.
Geheimer Webhook-Schlüssel	webhookSecret		string	Optional. Foxit eSign signiert jede Webhook-Nutzlast mit HMAC-SHA-256 mit diesem Geheimschlüssel zur Überprüfung.

Gibt zurück

Die ereignisdaten, die von Foxit eSign empfangen werden, wenn ein Webhook-Ereignis ausgelöst wird.

WebhookEventPayload: WebhookEventPayload

Wenn ein Umschlag vollständig ausgeführt wird

Vorgangs-ID:: TriggerEnvelopeExecuted

Wird ausgelöst, wenn alle Empfänger signiert sind und der Umschlag vollständig ausgeführt wird.

Parameter

Name	Schlüssel	Erforderlich	Typ	Beschreibung
Kanalname	channelName	True	string	Ein Name, um dieses Webhook-Abonnement in Ihrem Konto zu identifizieren.
Webhook-Ebene	webhookLevel	True	string	Konto: wird für alle Umschläge (Web und API) ausgelöst. API-App: wird nur für Umschläge ausgelöst, die über die API erstellt wurden.
Geheimer Webhook-Schlüssel	webhookSecret		string	Optional. Foxit eSign signiert jede Webhook-Nutzlast mit HMAC-SHA-256 mit diesem Geheimschlüssel zur Überprüfung.

Gibt zurück

Die ereignisdaten, die von Foxit eSign empfangen werden, wenn ein Webhook-Ereignis ausgelöst wird.

WebhookEventPayload: WebhookEventPayload

Definitionen

WebhookEventPayload

Die ereignisdaten, die von Foxit eSign empfangen werden, wenn ein Webhook-Ereignis ausgelöst wird.

Name	Pfad	Typ	Beschreibung
Ereignisname	event_name	string	Der Name des ausgelösten Ereignisses (z. B. folder_sent, folder_signed, folder_executed).
Ereignisdatum	event_date	integer	Das Datum und die Uhrzeit des Ereignisses (Unix-Zeitstempel in Millisekunden).
ID	data.folder.folderId	integer	Die eindeutige ID des Umschlags.
Name	data.folder.folderName	string	Der Name des Umschlags.
Benutzerdefinierter Name	data.folder.folderCustomName	string	Der benutzerdefinierte Name, der dem Umschlag zugewiesen ist.
Password	data.folder.folderPassword	string	Das Zugriffskennwort für den Umschlag, falls festgelegt.
Ersteller-ID	data.folder.folderAuthorId	integer	Die Benutzer-ID des Umschlagererstellers.
Creator Vorname	data.folder.folderAuthorFirstName	string	Der Vorname des Briefumschlagerstellers.
Creator-Nachname	data.folder.folderAuthorLastName	string	Der Nachname des Briefumschlagerstellers.
Creator-E-Mail	data.folder.folderAuthorEmail	string	Die E-Mail-Adresse des Briefumschlagerstellers.
Erstellerrolle	data.folder.folderAuthorRole	string	Die Kontorolle des Umschlagerstellers.
Unternehmens-ID	data.folder.folderCompanyId	integer	Die Firmen-ID, die den Umschlag besitzt.
Erstellungsdatum	data.folder.folderCreationDate	integer	Das Datum, an dem der Umschlag erstellt wurde (Unix-Zeitstempel in Millisekunden).
Sendedatum	data.folder.folderSentDate	integer	Das Datum, an dem der Umschlag gesendet wurde (Unix-Zeitstempel in Millisekunden).
Status	data.folder.folderStatus	string	Der aktuelle Status des Umschlags.
Benutzerdefiniertes Feld 1	data.folder.custom_field1	string	Das erste benutzerdefinierte Metadatenfeld.
Benutzerdefiniertes Feld 2	data.folder.custom_field2	string	Das zweite benutzerdefinierte Metadatenfeld.
Metadaten	data.folder.metadata	string	Benutzerdefinierte Metadaten, die dem Umschlag zugeordnet sind.
Dokument-IDs	data.folder.folderDocumentIds	array of integer	Die Liste der Dokument-IDs im Umschlag.
Dokumente	data.folder.documentsList	array of object	Die Liste der Dokumente im Umschlag.
Dokument-ID	data.folder.documentsList.documentId	integer	Der eindeutige Bezeichner des Dokuments.
Vertrags-ID	data.folder.documentsList.contractId	integer	Die Vertrags-ID für dieses Dokument.
Unternehmens-ID	data.folder.documentsList.companyId	integer	Die Firmen-ID für dieses Dokument.
Erstellt von	data.folder.documentsList.contractCreatedBy	integer	Die Benutzer-ID der Person, die den Vertrag erstellt hat.
Erstellt am	data.folder.documentsList.contractCreatedOn	integer	Das Datum, an dem der Vertrag erstellt wurde (Unix-Zeitstempel in Millisekunden).
Vertragsart	data.folder.documentsList.contractType	string	Der Vertragstyp.
Vertragsstatus	data.folder.documentsList.contractStatus	string	Der aktuelle Status des Vertrags.
Bearbeitbar	data.folder.documentsList.editable	boolean	Gibt an, ob das Dokument bearbeitet werden kann.
Versions-ID	data.folder.documentsList.contractVersionId	integer	Die Versions-ID des Vertrags.
Versionsname	data.folder.documentsList.contractVersionName	string	Der Name der Vertragsversion.
Versionsbeschreibung	data.folder.documentsList.contractVersionDesc	string	Eine Beschreibung der Vertragsversion.
Version erstellt von	data.folder.documentsList.versionCreatedby	integer	Die Benutzer-ID der Person, die diese Version erstellt hat.
Version erstellt am	data.folder.documentsList.versionCreatedOn	integer	Das Datum, an dem diese Version erstellt wurde (Unix-Zeitstempel in Millisekunden).
Versionsnummer	data.folder.documentsList.contractVersionNumber	integer	Die Versionsnummer des Vertrags.
Transaktionsquelle	data.folder.documentsList.contractTransactionSource	string	Das Quellsystem, das den Vertrag initiiert hat.
Empfänger	data.folder.folderRecipientParties	array of object	Die Liste der Empfänger für diesen Umschlag.
Empfänger-ID	data.folder.folderRecipientParties.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Empfänger-ID	data.folder.folderRecipientParties.partyDetails.partyId	integer	Die eindeutige ID des Empfängers.
Vorname	data.folder.folderRecipientParties.partyDetails.firstName	string	Der Vorname des Empfängers.
Nachname	data.folder.folderRecipientParties.partyDetails.lastName	string	Der Nachname des Empfängers.
Email	data.folder.folderRecipientParties.partyDetails.emailId	string	Die E-Mail-Adresse des Empfängers.
Platzhalter	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	Gibt an, ob es sich um einen Platzhalterempfänger handelt.
Adresse	data.folder.folderRecipientParties.partyDetails.address	string	Die Adresse des Empfängers.
Erstellt am	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	Das Datum, an dem der Empfängerdatensatz erstellt wurde (Unix-Zeitstempel in Millisekunden).
Abmelden von E-Mails	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	Gibt an, ob der Empfänger E-Mails abgemeldet hat.
Eindeutige Kennung	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	Ein eindeutiger Systembezeichner für diesen Empfänger.
Authentifizierungsebene	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	Die Authentifizierungsmethode für diesen Empfänger.
Kennwort aktualisiert am	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	Das Datum, an dem das Kennwort zuletzt aktualisiert wurde.
Kennwortstatus	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	Gibt an, ob das Kennwort aktualisiert wurde.
Wählcode	data.folder.folderRecipientParties.dialingCode	string	Die internationale Wählnummer.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	Die Mobiltelefonnummer des Empfängers.
Signaturtyp	data.folder.folderRecipientParties.signerSignatureType	string	Der Signaturtyp, den der Signierer verwendet.
Erlaubnisse	data.folder.folderRecipientParties.contractPermissions	string	Die Berechtigungen, die diesem Empfänger erteilt wurden.
Signierreihenfolge	data.folder.folderRecipientParties.partySequence	integer	Die Signierreihenfolge für diesen Empfänger.
Workflowsequenz	data.folder.folderRecipientParties.workflowSignSequence	integer	Die Nummer der Workflowsignatursequenz.
Umschlag-ID	data.folder.folderRecipientParties.envelopeId	integer	Die mit diesem Empfänger verknüpfte Umschlag-ID.
Firmen-ID des Empfängers	data.folder.folderRecipientParties.partyCompanyId	integer	Die Firmen-ID dieses Empfängers.
Freigabemodus	data.folder.folderRecipientParties.sharingMode	string	Der Freigabemodus für diesen Empfänger.
Url für die Empfängersignierung	data.folder.folderRecipientParties.folderAccessURL	string	Die URL für diesen Empfänger, um auf den Umschlag zuzugreifen und sie zu signieren.
Sicherheitsmodus	data.folder.folderRecipientParties.securityMode	string	Der Sicherheitsmodus für diesen Empfänger.
Kommentare	data.folder.folderRecipientParties.extraComments	string	Zusätzliche Kommentare für den Empfänger.
Namensänderung zulassen	data.folder.folderRecipientParties.allowNameChange	boolean	Gibt an, ob der Empfänger seinen Namen aktualisieren kann.
Name aktualisiert	data.folder.folderRecipientParties.signerNameUpdated	boolean	Gibt an, ob der Signierer seinen Namen aktualisiert hat.
Signierer-Authentifizierungsebene	data.folder.folderRecipientParties.signerAuthenticationLevel	string	Die für den Signierer erforderliche Authentifizierungsstufe.
Zugangscode	data.folder.folderRecipientParties.userDefinedAccessCode	string	Ein benutzerdefinierter Zugriffscode für den Signierer.
Signatur-ID	data.folder.folderRecipientParties.signatureId	string	Die ID der angewendeten Signatur.
Rolle	data.folder.folderRecipientParties.partyRole	string	Die Rolle dieses Empfängers im Signaturworkflow.
Firmenfeld	data.folder.folderRecipientParties.companyFieldValue	string	Der Feldwert des Firmennamens.
Titelfeld	data.folder.folderRecipientParties.titleFieldValue	string	Der Wert des Titelfelds.
Grund für die Signierung	data.folder.folderRecipientParties.reasonSigning	string	Der Grund für die Unterzeichnung.
Zahlungsfeld hinzugefügt	data.folder.folderRecipientParties.payFieldAdded	boolean	Gibt an, ob ein Zahlungsfeld hinzugefügt wurde.
Zahlungsempfänger	data.folder.folderRecipientParties.payee	boolean	Gibt an, ob dieser Empfänger der Zahlungsempfänger ist.
Wiederkehrende Zahlung	data.folder.folderRecipientParties.recurringFieldExist	boolean	Gibt an, ob ein Wiederkehrendes Zahlungsfeld vorhanden ist.
Drucken und Signieren fertig	data.folder.folderRecipientParties.printAndSignCompleted	boolean	Gibt an, ob das Drucken und Signieren abgeschlossen ist.
Optionaler Signierer	data.folder.folderRecipientParties.allowOptionalSigner	boolean	Gibt an, ob dieser Empfänger ein optionaler Signierer ist.
Optionale Signierer	data.folder.folderRecipientParties.optionalSigners	array of integer	Optionale Signierer-Party-IDs.
Bezahlt	data.folder.folderRecipientParties.paid	boolean	Gibt an, ob die Zahlung abgeschlossen wurde.
Zugriffs-URL des Autors	data.folder.folderAccessURLForAuthor	string	Die URL für den Umschlagautor, um auf den Umschlag zuzugreifen.
Url des Entwurfszugriffs	data.folder.draftFolderAccessURL	string	Die URL für den Zugriff auf den Umschlag im Entwurfszustand.
BoardroomSignatur	data.folder.boardRoomSign	boolean	Gibt an, ob der Boardroomsignierungsmodus aktiviert ist.
Logo einschließen	data.folder.includeLogo	boolean	Gibt an, ob das Firmenlogo in E-Mails enthalten ist.
Schaltflächenhintergrundfarbe	data.folder.email_btnBgColor	string	Die Hintergrundfarbe der Interaktiven Schaltfläche "E-Mail".
Schaltflächentextfarbe	data.folder.email_btnTxtColor	string	Die Textfarbe der Interaktiven Schaltfläche "E-Mail".
E-Mail-Logo	data.folder.emailTemplateLogo	string	Die in der E-Mail-Vorlage verwendete Logo-URL.
E-Mail-Vorlagen-ID	data.folder.emailTemplateId	integer	Die ID der verwendeten E-Mail-Vorlage.
E-Mail-Kopfzeile	data.folder.emailHeader	string	Der Kopfzeilentext in Benachrichtigungs-E-Mails.
E-Mail-Fußzeile	data.folder.emailFooter	string	Der Fußzeilentext in Benachrichtigungs-E-Mails.
Geplante Bereinigung	data.folder.purgeFlag	boolean	Gibt an, ob der Umschlag für die Bereinigung geplant ist.
Startdatum löschen	data.folder.purgeStartDate	string	Das Startdatum für den Löschzeitplan.
Enddatum löschen	data.folder.purgeEndDate	string	Das Enddatum für den Löschzeitplan.
Massen-ID	data.folder.bulkId	integer	Die Id des Massenvorgangs, falls zutreffend.
Signierreihenfolge erzwingen	data.folder.enforceSignWorkflow	boolean	Gibt an, ob sich Empfänger in der definierten Reihenfolge anmelden müssen.
Aktueller Workflowschritt	data.folder.currentWorkflowStep	integer	Der aktuelle Schritt im Signaturworkflow.
Transaktionsquelle	data.folder.transactionSource	string	Das Quellsystem, das diese Transaktion initiiert hat.
Bearbeitbar	data.folder.editable	boolean	Gibt an, ob der Umschlag bearbeitbar ist.
In-Person Signierung	data.folder.inPersonSignable	boolean	Gibt an, ob der Umschlag die persönliche Signatur unterstützt.
Überschreiben von Erinnerungen	data.folder.overrideAccountReminders	boolean	Gibt an, ob Erinnerungseinstellungen auf Kontoebene überschrieben werden.
Delegierung außer Kraft setzen	data.folder.overrideAccountRecipientDelegation	boolean	Gibt an, ob Delegierungseinstellungen auf Kontoebene außer Kraft gesetzt werden.
Delegierung zulassen	data.folder.allowRecipientsToDelegate	boolean	Gibt an, ob Empfänger die Signierung delegieren können.
ID	data.folder.envelopeId	integer	Die eindeutige Umschlag-ID (Alias von folderId).
Name	data.folder.envelopeName	string	Der Umschlagname (Alias von folderName).
Absender-ID	data.folder.envelopeOriginatorId	integer	Die Benutzer-ID, die den Umschlag stammte.
Unternehmens-ID	data.folder.envelopeCompanyId	integer	Die Firmen-ID, die den Umschlag besitzt.
Datum	data.folder.envelopeDate	integer	Das Datum, an dem der Umschlag erstellt wurde (Unix-Zeitstempel in Millisekunden).
Freigegebenes Datum	data.folder.envelopeSharedDate	integer	Das Datum, an dem der Umschlag geteilt wurde (Unix-Zeitstempel in Millisekunden).
Status	data.folder.envelopeStatus	string	Der aktuelle Status des Umschlags.
Vertrags-IDs	data.folder.envelopeContractIds	array of integer	Die mit diesem Umschlag verknüpften Vertrags-IDs.
Partyberechtigungen	data.folder.envelopePartyPermissions	array of object	Die Empfängerberechtigungsliste (gleiche Struktur wie Empfänger).
Empfänger-ID	data.folder.envelopePartyPermissions.partyId	integer	Der eindeutige Bezeichner des Empfängers.
Empfänger-ID	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
Vorname	data.folder.envelopePartyPermissions.partyDetails.firstName	string
Nachname	data.folder.envelopePartyPermissions.partyDetails.lastName	string
Email	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Platzhalter	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Adresse	data.folder.envelopePartyPermissions.partyDetails.address	string
Erstellt am	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
Abmelden von E-Mails	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
Eindeutige Kennung	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
Authentifizierungsebene	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
Kennwort aktualisiert am	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
Kennwortstatus	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
Wählcode	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
Signaturtyp	data.folder.envelopePartyPermissions.signerSignatureType	string
Erlaubnisse	data.folder.envelopePartyPermissions.contractPermissions	string
Signierreihenfolge	data.folder.envelopePartyPermissions.partySequence	integer
Workflowsequenz	data.folder.envelopePartyPermissions.workflowSignSequence	integer
Umschlag-ID	data.folder.envelopePartyPermissions.envelopeId	integer
Firmen-ID des Empfängers	data.folder.envelopePartyPermissions.partyCompanyId	integer
Freigabemodus	data.folder.envelopePartyPermissions.sharingMode	string
Url für die Empfängersignierung	data.folder.envelopePartyPermissions.folderAccessURL	string
Sicherheitsmodus	data.folder.envelopePartyPermissions.securityMode	string
Kommentare	data.folder.envelopePartyPermissions.extraComments	string
Namensänderung zulassen	data.folder.envelopePartyPermissions.allowNameChange	boolean
Name aktualisiert	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
Signierer-Authentifizierungsebene	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
Zugangscode	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
Signatur-ID	data.folder.envelopePartyPermissions.signatureId	string
Rolle	data.folder.envelopePartyPermissions.partyRole	string
Firmenfeld	data.folder.envelopePartyPermissions.companyFieldValue	string
Titelfeld	data.folder.envelopePartyPermissions.titleFieldValue	string
Grund für die Signierung	data.folder.envelopePartyPermissions.reasonSigning	string
Zahlungsfeld hinzugefügt	data.folder.envelopePartyPermissions.payFieldAdded	boolean
Zahlungsempfänger	data.folder.envelopePartyPermissions.payee	boolean
Wiederkehrende Zahlung	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
Drucken und Signieren fertig	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
Optionaler Signierer	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
Optionale Signierer	data.folder.envelopePartyPermissions.optionalSigners	array of integer
Bezahlt	data.folder.envelopePartyPermissions.paid	boolean
Authentifizierungsebene	data.folder.envelopeAuthenticationLevel	string	Die für den Umschlag erforderliche Authentifizierungsstufe.
Massenhinzufügen von Single Signer	data.folder.allowSingleSignerInBulk	boolean	Gibt an, ob ein single signer im Massenmodus zulässig ist.
File-Based Ordnername	data.folder.folderNameBasedOnFileNaming	boolean
File-Based Dokumentname	data.folder.documentNameBasedOnFileNaming	boolean
File-Based Zertifikatname	data.folder.certificateNameBasedOnFileNaming	boolean
Prä-Exec-Dateibenennung	data.folder.enableFileNamingBeforeExecution	boolean
Payee hinzugefügt	data.folder.payeeAddedd	boolean
Self-Signing aktiviert	data.folder.selfSignerEnabled	boolean
Notar aktiviert	data.folder.notaryEnabled	boolean
Eingeschränkte Sichtbarkeit	data.folder.limitedVisibilityFlag	boolean
Sichtbarkeit nach dem Signieren	data.folder.postSigningVisibility	boolean
Nasse Signatur	data.folder.wetSignatureEnabled	boolean
Seriendruck aktiviert	data.folder.mergeEnabled	boolean

binary

Dies ist der grundlegende Datentyp "binary".