Annature (Unabhängiger Herausgeber) (Vorschau)
Annature ist die führende australische eSigning-Lösung mit einem integrierten Anbieter für digitale Signaturen. Dieser Connector hilft Unternehmen beim Erstellen von Umschlägen und der Integration von Annature-Dokumentensignierungsworkflows mithilfe der Annature-API (v1).
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | 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 Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Dr. Adrian Colquhoun (Strategik) |
| URL | https://www.linkedin.com/in/adriancolquhoun/ |
| adrian@strategik.com.au |
| Connectormetadaten | |
|---|---|
| Herausgeber | Dr. Adrian Colquhoun (Strategik) |
| Webseite | https://annature.com.au |
| Datenschutzrichtlinie | https://www.annature.com.au/privacy-policy |
| Kategorien | Produktivität |
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Annature Id | Schnur | Annature Id | Richtig |
| Annature Key | securestring | Annature Key | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen aller Anlagen für ein Feld |
Abrufen von Feldanlagen |
| Briefumschlag abrufen |
Briefumschlag abrufen |
| Briefumschlag erstellen |
Briefumschlag erstellen |
| Briefumschlag senden |
Briefumschlag senden |
| Dokumente abrufen |
Alle Dokumente für einen Umschlag auflisten |
| Empfänger abrufen |
Abrufen eines einzelnen Empfängers, der für einen Umschlag erstellt wurde, mithilfe der ID-Eigenschaft, die im Antworttext eines Umschlags zurückgegeben wurde |
| Feld abrufen |
Feld abrufen |
| Felder abrufen |
Alle Felder auflisten |
| Konten abrufen |
Alle Konten auflisten |
| Leerer Briefumschlag |
Briefumschlag senden |
| Organisation abrufen |
Organisation abrufen |
| Umschlag aus Vorlage erstellen |
Vorlage verwenden |
| Umschlag löschen |
Umschlag löschen |
| Umschläge abrufen |
Alle Umschläge auflisten |
| Vorlage abrufen |
Vorlage abrufen |
| Vorlagen abrufen |
Alle Vorlagen auflisten |
Abrufen aller Anlagen für ein Feld
Abrufen von Feldanlagen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
envelope_id | True | string |
Umschlag-ID |
|
Feld-ID
|
id | True | string |
Feld-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
Original
|
original | string | |
|
name
|
name | string | |
|
type
|
type | string | |
|
size
|
size | integer | |
|
erstellt
|
created | string |
Briefumschlag abrufen
Briefumschlag abrufen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
id | True | string |
Umschlag-ID |
|
Endpunktdauer
|
endpoint_duration | integer |
Legt die Anzahl der Minuten fest, für die die ursprünglichen Endpunkte und Masterendpunkte zugänglich sind. Die Zahl kann zwischen 1 und 10080 liegen, wobei der Standardwert 60 ist. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Id |
|
name
|
name | string |
Name |
|
message
|
message | string |
Nachricht |
|
status
|
status | string |
Der Status |
|
freigegeben
|
shared | boolean |
Shared |
|
erstellt
|
created | string |
Erstellt |
|
gesandt
|
sent | string |
Gesendet |
|
Ungültig
|
voided | string |
Ungültig gemacht |
|
abgelehnt
|
declined | string |
Abgelehnt |
|
abgeschlossen
|
completed | string |
Abgeschlossen |
|
master
|
master | string |
Master |
|
kombiniert
|
combined | string |
Kombiniert |
|
certificate
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
Konto-ID |
|
group_id
|
group_id | string |
Gruppen-ID |
|
Empfänger
|
recipients | array of object | |
|
Name
|
recipients.name | string |
Name |
|
E-Mail-ID
|
recipients.email | string |
E-Mail-ID |
|
Mobiltelefon
|
recipients.mobile | string |
Mobiltelefon |
|
Empfängertyp
|
recipients.type | string |
Der Empfängertyp wird standardmäßig als Signierer angegeben, wenn er nicht angegeben wird. |
|
Nachricht
|
recipients.message | string |
Nachricht |
|
Kennwort
|
recipients.password | ||
|
Gedämpft?
|
recipients.muted | boolean |
Dadurch wird Annature daran hindern, eine Korrespondenz an den Empfänger zu senden. |
|
Signierreihenfolge
|
recipients.order | integer |
Signierreihenfolge |
|
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat
|
recipients.redirects.session_completed | string |
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat |
|
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat
|
recipients.redirects.session_declined | string |
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat |
|
fields
|
recipients.fields | array of object | |
|
id
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
type
|
recipients.fields.type | string | |
|
Seite
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
Erforderlich
|
recipients.fields.required | boolean |
Erforderlich |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
Kollaborativ
|
recipients.fields.collaborative | boolean |
Kollaborativ |
|
width
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
erstellt
|
recipients.fields.created | string |
Briefumschlag erstellen
Briefumschlag erstellen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Der Name des Umschlags, der im Betreff der E-Mails angezeigt wird, die an Empfänger gesendet wurden, und beim Anzeigen des Umschlags |
|
Nachricht
|
message | string |
Nachricht |
|
|
Shared
|
shared | boolean |
Shared |
|
|
Ist Entwurf
|
draft | boolean |
Ist Entwurf |
|
|
Konto-ID
|
account_id | True | string |
Konto-ID |
|
Gruppen-ID
|
group_id | string |
Gruppen-ID |
|
|
Gruppen-ID
|
id | string |
Gruppen-ID |
|
|
Name
|
name | string |
Name |
|
|
Typ
|
type | string |
Typ |
|
|
Inhalt der Datei
|
base | byte |
Inhalt der Datei |
|
|
Name
|
name | string |
Name |
|
|
E-Mail-ID
|
string |
E-Mail-ID |
||
|
Mobiltelefon
|
mobile | string |
Mobiltelefon |
|
|
Empfängertyp
|
type | string |
Der Empfängertyp wird standardmäßig als Signierer angegeben, wenn er nicht angegeben wird. |
|
|
Nachricht
|
message | string |
Nachricht |
|
|
Kennwort
|
password | string | ||
|
Gedämpft?
|
muted | boolean |
Dadurch wird Annature daran hindern, eine Korrespondenz an den Empfänger zu senden. |
|
|
Signierreihenfolge
|
order | integer |
Signierreihenfolge |
|
|
Sitzung abgeschlossen
|
session_completed | string |
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat |
|
|
Sitzung abgelehnt
|
session_declined | string |
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat |
|
|
id
|
id | string | ||
|
recipient_id
|
recipient_id | string | ||
|
type
|
type | string |
Der Feldtyp |
|
|
Seite
|
page | integer | ||
|
x_coordinate
|
x_coordinate | integer | ||
|
y_coordinate
|
y_coordinate | integer | ||
|
Erforderlich
|
required | boolean |
Erforderlich |
|
|
Nur Lesen
|
read_only | boolean |
Nur Lesen |
|
|
Kollaborativ
|
collaborative | boolean |
Kollaborativ |
|
|
width
|
width | integer | ||
|
font_size
|
font_size | integer | ||
|
font_type
|
font_type | string |
Mögliche Werte sind Courier und helvetica |
|
|
erstellt
|
created | string |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Id |
|
name
|
name | string |
Name |
|
message
|
message | string |
Nachricht |
|
status
|
status | string |
Der Status |
|
Shared
|
shared | boolean |
Shared |
|
Erstellt am
|
created | string |
Erstellt am |
|
Nachgeschickt
|
sent | string |
Nachgeschickt |
|
Ungültig
|
voided | ||
|
abgelehnt
|
declined | ||
|
abgeschlossen
|
completed | ||
|
Konto-ID
|
account_id | string |
Account_id |
|
Gruppen-ID
|
group_id | string |
Gruppen-ID |
|
recipients
|
recipients | array of object | |
|
id
|
recipients.id | string | |
|
name
|
recipients.name | string | |
|
E-Mail
|
recipients.email | string | |
|
mobile
|
recipients.mobile | string | |
|
type
|
recipients.type | string | |
|
status
|
recipients.status | string | |
|
message
|
recipients.message | string | |
|
Kennwort
|
recipients.password |
Kennwort |
|
|
Gedämpft
|
recipients.muted | boolean |
Gedämpft |
|
order
|
recipients.order | integer | |
|
declined_reason
|
recipients.declined_reason | ||
|
erstellt
|
recipients.created | string | |
|
gesandt
|
recipients.sent | string | |
|
abgelehnt
|
recipients.declined | ||
|
abgeschlossen
|
recipients.completed | ||
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Briefumschlag senden
Briefumschlag senden
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
id | True | string |
Umschlag-ID |
Dokumente abrufen
Alle Dokumente für einen Umschlag auflisten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
envelope_id | True | string |
Umschlag-ID |
|
Endpunktdauer
|
endpoint_duration | integer |
Legt die Anzahl der Minuten fest, für die die ursprünglichen Endpunkte und Masterendpunkte zugänglich sind. Die Zahl kann zwischen 1 und 10080 liegen, wobei der Standardwert 60 ist. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
Id
|
id | string |
Id |
|
Name
|
name | string |
Name |
|
pages
|
pages | integer | |
|
Original
|
original | string |
Original |
|
Master
|
master | string |
Master |
|
Erstellt
|
created | string |
Erstellt |
Empfänger abrufen
Abrufen eines einzelnen Empfängers, der für einen Umschlag erstellt wurde, mithilfe der ID-Eigenschaft, die im Antworttext eines Umschlags zurückgegeben wurde
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Recipient
|
id | True | string |
Empfänger-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Id
|
id | string |
Id |
|
name
|
name | string |
Name |
|
E-Mail
|
string |
|
|
|
mobile
|
mobile | string |
Mobiltelefon |
|
type
|
type | string |
Typ |
|
status
|
status | string |
Der Status |
|
message
|
message | string |
Nachricht |
|
Kennwort
|
password |
Kennwort |
|
|
Gedämpft
|
muted | boolean |
Gedämpft |
|
order
|
order | integer | |
|
declined_reason
|
declined_reason | string |
Declined_reason |
|
erstellt
|
created | string |
Erstellt |
|
gesandt
|
sent | string |
Gesendet |
|
abgelehnt
|
declined | string |
Abgelehnt |
|
abgeschlossen
|
completed | string |
Abgeschlossen |
|
session_completed
|
redirects.session_completed | string |
Session_completed |
|
session_declined
|
redirects.session_declined | string |
Session_declined |
Feld abrufen
Feld abrufen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
envelope_id | True | string |
Umschlag-ID |
|
Feld-ID
|
id | True | string |
Feld-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Id |
|
recipient_id
|
recipient_id | string |
Empfänger-ID |
|
type
|
type | string |
Typ |
|
Seite
|
page | integer | |
|
Anker
|
anchor | string |
Anchor |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
Erforderlich
|
required | boolean |
Erforderlich |
|
Read_only
|
read_only | boolean |
Read_only |
|
Kollaborativ
|
collaborative | boolean |
Ermöglicht anderen Empfängern auf dem Umschlag, die Werte zu ändern. |
|
value
|
value | string |
Der Wert des Felds |
|
Geprüft
|
checked | boolean |
Geprüft |
|
height
|
height | integer | |
|
width
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string |
Mögliche Werte sind Courier und helvetica |
|
date_format
|
date_format | string |
Datumsformat |
|
erstellt
|
created | string |
Erstellt |
Felder abrufen
Alle Felder auflisten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
envelope_id | True | string |
Umschlag-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
recipient_id
|
recipient_id | string | |
|
type
|
type | string | |
|
Seite
|
page | integer | |
|
Anker
|
anchor | string | |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
Erforderlich
|
required | boolean |
Erforderlich |
|
Read_only
|
read_only | boolean |
Read_only |
|
Kollaborativ
|
collaborative | boolean |
Kollaborativ |
|
value
|
value | string | |
|
Geprüft
|
checked | boolean |
Geprüft |
|
height
|
height | integer | |
|
width
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string | |
|
date_format
|
date_format | string | |
|
erstellt
|
created | string |
Konten abrufen
Alle Konten auflisten
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
Name
|
name | string |
Name |
|
Email
|
string |
|
|
|
number
|
number | string | |
|
timezone
|
timezone | string | |
|
role
|
role | string | |
|
active
|
active | boolean | |
|
group_id
|
group_id | string | |
|
erstellt
|
created | string | |
|
verifiziert
|
verified | string |
Leerer Briefumschlag
Briefumschlag senden
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
id | True | string |
Umschlag-ID |
Organisation abrufen
Organisation abrufen
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Id |
|
name
|
name | string |
Name |
|
Geschäft
|
business | string |
Geschäft |
|
E-Mail
|
string |
|
|
|
number
|
number | string |
Number |
|
address
|
address | string |
Adresse |
|
Website
|
website | string |
Webseite |
|
logo
|
logo | string |
Logo |
|
Farbe
|
colour | string |
Farbe |
|
erstellt
|
created | string |
Erstellt |
Umschlag aus Vorlage erstellen
Vorlage verwenden
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagen-ID
|
id | True | string |
Vorlagen-ID |
|
Name
|
name | string |
Der Name des Umschlags, der im Betreff der E-Mails angezeigt wird, die an Empfänger gesendet wurden, und beim Anzeigen des Umschlags |
|
|
Ist Entwurf
|
draft | boolean |
Ist Entwurf |
|
|
Nachricht
|
message | string |
Nachricht |
|
|
Shared
|
shared | boolean |
Shared |
|
|
Konto-ID
|
account_id | True | string |
Konto-ID |
|
Gruppen-ID
|
group_id | string |
Gruppen-ID |
|
|
Gruppen-ID
|
id | string |
Gruppen-ID |
|
|
Name
|
name | string |
Name |
|
|
Gruppen-ID
|
type | string |
Gruppen-ID |
|
|
Inhalt der Datei
|
base | byte |
Inhalt der Datei |
|
|
Rollen-ID
|
role_id | string |
Rollen-ID |
|
|
Name
|
name | string |
Name |
|
|
E-Mail-ID
|
string |
E-Mail-ID |
||
|
Mobiltelefon
|
mobile | string |
Mobiltelefon |
|
|
SMS Auth
|
sms_auth | string |
SMS Auth |
|
|
Empfängertyp
|
type | string |
Der Empfängertyp wird standardmäßig als Signierer angegeben, wenn er nicht angegeben wird. |
|
|
Nachricht
|
message | string |
Nachricht |
|
|
Kennwort
|
password | string | ||
|
Gedämpft?
|
muted | boolean |
Dadurch wird Annature daran hindern, eine Korrespondenz an den Empfänger zu senden. |
|
|
Signierreihenfolge
|
order | integer |
Signierreihenfolge |
|
|
Feld-ID (aus Vorlage)
|
id | True | string |
ID des Vorlagenfelds |
|
Wert
|
value | True | string |
Wert für dieses Feld |
|
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat
|
session_completed | string |
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat |
|
|
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat
|
session_declined | string |
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Id |
|
name
|
name | string |
Name |
|
message
|
message | string |
Nachricht |
|
freigegeben
|
shared | boolean |
Ist freigegeben? |
|
draft
|
draft | boolean | |
|
account_id
|
account_id | string |
Konto-ID |
|
group_id
|
group_id | string |
Gruppen-ID |
|
Urkunden
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Name
|
documents.name | string |
Name |
|
pages
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Master
|
documents.master | string |
Master |
|
Erstellt
|
documents.created | string |
Erstellt |
|
recipients
|
recipients | array of object | |
|
role_id
|
recipients.role_id | string | |
|
name
|
recipients.name | string | |
|
E-Mail
|
recipients.email | string | |
|
mobile
|
recipients.mobile | string | |
|
message
|
recipients.message | string | |
|
Kennwort
|
recipients.password | boolean | |
|
gedämpft
|
recipients.muted | boolean | |
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Umschlag löschen
Umschlag löschen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlag-ID
|
id | True | string |
Umschlag-ID |
Umschläge abrufen
Alle Umschläge auflisten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Umschlagname
|
name | string |
Ein exakter Abgleichsfilter für die Liste basierend auf der Namenseigenschaft des Umschlags |
|
|
Umschlagstatus
|
status | string |
Ein exakter Abgleichsfilter für die Liste basierend auf dem Umschlagstatus |
|
|
Empfängername
|
recipient | string |
Ein exakter Übereinstimmungsfilter für die Liste basierend auf dem Namen oder der E-Mail-Eigenschaft eines Empfängers |
|
|
Erstellt vor
|
created_before | date |
Gibt Ergebnisse zurück, bei denen das Erstellungsdatum vor dem angegebenen Wert liegt. |
|
|
Erstellt nach
|
created_after | date |
Gibt Ergebnisse zurück, bei denen das Erstellungsdatum nach dem angegebenen Wert liegt. |
|
|
Abgeschlossen vor
|
completed_before | date |
Gibt Ergebnisse zurück, bei denen das Abgeschlossene Datum vor dem angegebenen Wert liegt. |
|
|
Abgeschlossen nach
|
completed_after | date |
Gibt Ergebnisse zurück, bei denen das Abgeschlossene Datum nach dem angegebenen Wert liegt. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
Id |
|
name
|
name | string |
Name |
|
message
|
message | string |
Nachricht |
|
status
|
status | string |
Der Status |
|
freigegeben
|
shared | boolean |
Shared |
|
erstellt
|
created | string |
Erstellt |
|
gesandt
|
sent | string |
Gesendet |
|
Ungültig
|
voided | string |
Ungültig gemacht |
|
abgelehnt
|
declined | string |
Abgelehnt |
|
abgeschlossen
|
completed | string |
Abgeschlossen |
|
kombiniert
|
combined | string |
Kombiniert |
|
master
|
master | string |
Master |
|
certificate
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
Konto-ID |
|
group_id
|
group_id | string |
Gruppen-ID |
|
Empfänger
|
recipients | array of object | |
|
Name
|
recipients.name | string |
Name |
|
E-Mail-ID
|
recipients.email | string |
E-Mail-ID |
|
Mobiltelefon
|
recipients.mobile | string |
Mobiltelefon |
|
Empfängertyp
|
recipients.type | string |
Der Empfängertyp wird standardmäßig als Signierer angegeben, wenn er nicht angegeben wird. |
|
Nachricht
|
recipients.message | string |
Nachricht |
|
Kennwort
|
recipients.password | ||
|
Gedämpft?
|
recipients.muted | boolean |
Dadurch wird Annature daran hindern, eine Korrespondenz an den Empfänger zu senden. |
|
Signierreihenfolge
|
recipients.order | integer |
Signierreihenfolge |
|
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat
|
recipients.redirects.session_completed | string |
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat |
|
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat
|
recipients.redirects.session_declined | string |
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat |
|
fields
|
recipients.fields | array of object | |
|
id
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
type
|
recipients.fields.type | string | |
|
Seite
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
Erforderlich
|
recipients.fields.required | boolean |
Erforderlich |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
Kollaborativ
|
recipients.fields.collaborative | boolean |
Kollaborativ |
|
width
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
erstellt
|
recipients.fields.created | string |
Vorlage abrufen
Vorlage abrufen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Vorlagen-ID
|
id | True | string |
Vorlagen-ID |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
name
|
name | string | |
|
Shared
|
shared | boolean |
Shared |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
erstellt
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
Urkunden
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Name
|
documents.name | string |
Name |
|
pages
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Master
|
documents.master | string |
Master |
|
Erstellt
|
documents.created | string |
Erstellt |
|
roles
|
roles | array of object | |
|
Id
|
roles.id | string |
Id |
|
Name
|
roles.name | string |
Name |
|
Empfängername
|
roles.recipient_name | string |
Empfängername |
|
Empfänger-E-Mail
|
roles.recipient_email | string |
Empfänger-E-Mail |
|
Empfänger mobiler Empfänger
|
roles.recipient_mobile | string |
Empfänger mobiler Empfänger |
|
Empfängertyp
|
roles.recipient_type | string |
Der Empfängertyp wird standardmäßig als Signierer angegeben, wenn er nicht angegeben wird. |
|
Kennwort
|
roles.recipient_password | string |
Kennwort |
|
Signierreihenfolge
|
roles.order | integer |
Signierreihenfolge |
|
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat
|
roles.recipient_redirects.session_completed | string |
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat |
|
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat
|
roles.recipient_redirects.session_declined | string |
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat |
Vorlagen abrufen
Alle Vorlagen auflisten
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | string |
Ein exakter Übereinstimmungsfilter für die Liste basierend auf den Vorlagen |
|
|
Erstellt vor
|
created_before | date |
Gibt Ergebnisse zurück, bei denen das Erstellungsdatum vor dem angegebenen Wert liegt. |
|
|
Erstellt nach
|
created_after | date |
Gibt Ergebnisse zurück, bei denen das Erstellungsdatum nach dem angegebenen Wert liegt. |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string | |
|
name
|
name | string | |
|
Shared
|
shared | boolean |
Shared |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
erstellt
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
Urkunden
|
documents | array of object | |
|
Id
|
documents.id | string |
Id |
|
Name
|
documents.name | string |
Name |
|
pages
|
documents.pages | integer | |
|
Original
|
documents.original | string |
Original |
|
Master
|
documents.master | string |
Master |
|
Erstellt
|
documents.created | string |
Erstellt |
|
roles
|
roles | array of object | |
|
Id
|
roles.id | string |
Id |
|
Name
|
roles.name | string |
Name |
|
Empfängername
|
roles.recipient_name | string |
Empfängername |
|
Empfänger-E-Mail
|
roles.recipient_email | string |
Empfänger-E-Mail |
|
Empfänger mobiler Empfänger
|
roles.recipient_mobile | string |
Empfänger mobiler Empfänger |
|
Empfängertyp
|
roles.recipient_type | string |
Der Empfängertyp wird standardmäßig als Signierer angegeben, wenn er nicht angegeben wird. |
|
Kennwort
|
roles.recipient_password | string |
Kennwort |
|
Signierreihenfolge
|
roles.order | integer |
Signierreihenfolge |
|
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat
|
roles.recipient_redirects.session_completed | string |
Zielendpunkt, nachdem der Empfänger den Umschlag abgeschlossen hat |
|
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat
|
roles.recipient_redirects.session_declined | string |
Zielendpunkt, nachdem der Empfänger das Signieren des Umschlags abgelehnt hat |
Auslöser
| Ereignistrigger – Briefumschlag und Empfänger |
Triggers when an event occurs when envelopes completed or recipient views |
Ereignistrigger – Briefumschlag und Empfänger
Triggers when an event occurs when envelopes completed or recipient views
Gibt zurück
- Body
- WebhookEventContent
Definitionen
WebhookEventContent
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Ereignis
|
event | string | |
|
envelope_id
|
envelope_id | string | |
|
Ungültig
|
voided | string | |
|
abgeschlossen
|
completed | string | |
|
master
|
master | string | |
|
certificate
|
certificate | string | |
|
gesandt
|
sent | string | |
|
method
|
method | string | |
|
recipient_id
|
recipient_id | string | |
|
gesehen
|
viewed | string | |
|
abgelehnt
|
declined | string | |
|
declined_reason
|
declined_reason | string | |
|
misslungen
|
failed | string | |
|
Diagnose
|
diagnosis | string |