Docusign
A Docusign lehetővé teszi a szervezetek számára, hogy a teljes szerződés életciklusa során létrehozzák, véglegesítsék és kezeljék a megállapodásaikat. Az ügyfelek felgyorsíthatják a bevételt, csökkenthetik a kockázatot, és felszabadíthatják az üzleti tevékenységüket futtató megállapodások értékét.
Ez az összekötő a következő termékekben és régiókban érhető el:
| Service | Class | Régiók |
|---|---|---|
| Copilot Studio | Standard | Az összes Power Automate-régió, kivéve a következőket: - A 21Vianet által üzemeltetett China Cloud |
| Logikai alkalmazások | Standard | Az összes Logic Apps-régió , kivéve a következőket: - Azure China-régiók - Amerikai Védelmi Minisztérium (DoD) |
| Power Alkalmazások | Standard | Az összes Power Apps-régió , kivéve a következőket: - A 21Vianet által üzemeltetett China Cloud |
| Power Automate | Standard | Az összes Power Automate-régió, kivéve a következőket: - A 21Vianet által üzemeltetett China Cloud |
| Érintkezés | |
|---|---|
| Név | docusign |
| URL | https://support.docusign.com |
| Összekötő metaadatai | |
|---|---|
| Kiadó | DocuSign, Inc. |
| Webhely | https://www.docusign.com |
| Adatvédelmi irányelvek | https://www.docusign.com/company/privacy-policy |
| Kategóriák | Tartalom és fájlok; Termelékenység |
Cím
A DocuSign segít a szervezeteknek csatlakozni és automatizálni a szerződések előkészítését, aláírását, működését és kezelését. A DocuSign Demo-összekötő csak DocuSign Demo-környezetekhez csatlakozik, de ugyanazt a funkciót biztosítja, mint a normál DocuSign-összekötő.
Előfeltételek
A Connect-eseményindító ebben az integrációban való használatához a DocuSign Connectet engedélyezni kell a DocuSign-fiókjában. Alapértelmezés szerint nincs engedélyezve. Ha engedélyezve van, a Csatlakozás beállításai lap a DocuSign Felügyeleti webalkalmazásból érhető el. Ebben az integrációban a Connect-eseményindító automatikusan regisztrálja a webhookot.
Összekötő dokumentációja
Az összekötő részletes dokumentációját lásd: https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
Ismert problémák és korlátozások
A DocuSigntel kapcsolatos problémák esetén először próbálja ki ezt a hivatkozást: https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center.
Üzembe helyezési utasítások
Ezeket az utasításokat követve helyezze üzembe ezt az összekötőt egyéni összekötőként a Microsoft Power Automate-ben és a Power Appsben.
Szabályozási korlátok
| Name | Hívások | Megújítási időszak |
|---|---|---|
| API-hívások kapcsolatonként | 250 | 60 másodperc |
Műveletek
| A boríték érvénytelenítése |
Ürítse ki a borítékot. |
| A boríték újraküldése |
Ez a művelet újra elküld egy Docusign-borítékot, vagy emlékeztetőt küld azoknak a címzetteknek, akiknek egy megadott Borítékazonosító alapján alá kell írniuk egy Docusign-szerződést. |
| A címzett lap adatainak lekérése |
Az adott címzett lapjának értékét adja vissza |
| A címzett lap értékeinek frissítése egy borítékon |
A címzett lap értékeinek frissítése egy borítékon |
| Bejelentkezés |
Bejelentkezés |
| Beágyazott aláírási URL-cím létrehozása (V2) |
Beágyazott aláírási URL-cím létrehozása (V2) |
| Beágyazott aláírási URL-cím létrehozása [ELAVULT] |
Beágyazott aláírási URL-cím létrehozása |
| Beágyazott feladó URL-címének létrehozása |
Beágyazott feladó URL-címének létrehozása |
| Boríték egyéni mezőinformációinak lekérése |
Boríték egyéni mezőinformációinak lekérése. |
| Boríték küldése |
Küldjön egy meglévő borítékot. |
| Boríték létrehozása (V2) |
Hozzon létre egy új üres borítékot. |
| Boríték létrehozása sablonnal |
Hozzon létre egy új borítékot egy megadott sablon használatával. |
| Boríték létrehozása sablonnal a címzettekkel |
Hozzon létre egy új borítékot egy megadott sablon használatával, és adja meg a címzetteket. |
| Boríték létrehozása sablonnal címzettekkel és lapokkal |
Boríték létrehozása sablonnal címzettekkel és lapokkal |
| Boríték létrehozása összetett sablonok használatával |
Boríték létrehozása összetett sablonok használatával |
| Boríték tömeges küldése sablonnal |
Boríték tömeges küldése sablonnal |
| Borítékok előtöltési lapjának frissítése |
Az előtöltési lapok listájának értékeinek frissítése |
| Borítékok listázása |
Ez a művelet visszaadja a releváns Docusign-borítékokat a boríték állapota, a dátumtartomány, a címzett neve, a címzett e-mail címe, a boríték címe, a dokumentum neve vagy a boríték egyéni mezőértéke alapján. A kimenet a cím, a leírás, a boríték azonosítója, a dokumentumnevek, a feladók neve, a boríték állapota, az állapot dátuma, az elküldött dátum és a boríték URL-címe, amely hivatkozásként használható a boríték Docusignban való megtekintéséhez. |
| Buildszám megjelenítése (csak referenciaként. Ne szerepeljen a folyamatban végrehajtás céljából) |
A jelenleg üzembe helyezett build azonosítója. |
| Címzett adatainak lekérése borítékból |
Címzett adatainak lekérése borítékból |
| Címzett eltávolítása borítékból |
Címzett eltávolítása borítékból |
| Címzett frissítése borítékon |
Címzett frissítése borítékon |
| Címzett hozzáadása borítékhoz (V2) |
Címzett hozzáadása egy borítékhoz. |
| Címzett lapfülek lekérése borítékból |
Címzett lapfülek lekérése borítékból |
| Címzettek listázása borítékból |
Címzettek listázása borítékból |
| Docusign-munkafolyamat indítása |
Docusign-munkafolyamat indítása |
| Dokumentum egyéni mezőinek lekérése borítékból |
Dokumentum egyéni mezőinek lekérése borítékból |
| Dokumentumadatok lekérése borítékból |
Dokumentumadatok lekérése borítékból |
| Dokumentumfülek lekérése borítékból |
Dokumentumfülek lekérése borítékból |
| Dokumentumfülek lekérése sablonból |
Dokumentumfülek lekérése sablonból |
| Dokumentumgenerálási űrlapmezők frissítése borítékból |
Dokumentumgenerálási űrlapmezők frissítése borítékból |
| Dokumentumgenerálási űrlapmezők lekérése borítékból |
Dokumentumgenerálási űrlapmezők lekérése borítékból |
| Dokumentumgenerálási űrlapmezők lekérése sablonból (csak tömeges sablonküldés) |
Dokumentumgenerálási űrlapmezők lekérése sablonból (csak tömeges sablonküldés) |
| Dokumentumok hozzáadása borítékhoz |
Dokumentumok hozzáadása borítékhoz. |
| Dokumentumok lekérése borítékból |
Dokumentumok lekérése borítékból |
| Dokumentumok listázása borítékból |
Dokumentumok listázása borítékból |
| Dokumentumok listázása sablonból |
Dokumentumok listázása sablonból |
| Egyéni boríték mező frissítése |
A megadott egyéni borítékmező értékének frissítése |
| ELAVULT: Boríték létrehozása sablonnal (elavult) [ELAVULT] |
Hozzon létre egy új borítékot egy megadott sablon használatával (elavult). |
| ELAVULT: Címzett hozzáadása borítékhoz (elavult) [ELAVULT] |
Címzett hozzáadása borítékhoz (elavult). |
| ELAVULT: Dokumentumok lekérése borítékból (elavult) [ELAVULT] |
Dokumentumok lekérése borítékból (elavult) |
| Ellenőrzési típus hozzáadása címzetthez |
Adjon hozzá ellenőrzési típust egy címzetthez. |
| Emlékeztetők hozzáadása borítékhoz |
Emlékeztetők hozzáadása borítékhoz |
| Lapfülek hozzáadása egy címzetthez egy borítékon |
Lapfülek hozzáadása egy címzetthez egy borítékon |
| Listasablonok |
Adott fiók sablonjainak listázása. |
| Naplózási eseménylista lekérése |
Naplózási eseménylista lekérése |
| Sablon alkalmazása dokumentumokra |
Sablon alkalmazása dokumentumokra |
| Tömeges küldési lista létrehozása |
Tömeges küldési lista létrehozása |
A boríték érvénytelenítése
Ürítse ki a borítékot.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Érvénytelenség oka
|
voidedReason | True | string |
Érvénytelenített ok |
Válaszok
- response
- object
A boríték újraküldése
Ez a művelet újra elküld egy Docusign-borítékot, vagy emlékeztetőt küld azoknak a címzetteknek, akiknek egy megadott Borítékazonosító alapján alá kell írniuk egy Docusign-szerződést.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
Válaszok
- response
- object
A címzett lap adatainak lekérése
Az adott címzett lapjának értékét adja vissza
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Címzett azonosítója
|
recipientId | True | string |
Adjon meg egy címzett-azonosítót. |
|
Tabulátorcímke
|
tabLabel | True | string |
Tabulátorcímke |
Válaszok
- Törzs
- Tab
A címzett lap értékeinek frissítése egy borítékon
A címzett lap értékeinek frissítése egy borítékon
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Címzett azonosítója
|
recipientId | True | string |
Adjon meg egy címzett-azonosítót. |
|
Típus
|
tabType | string |
Tabulátor típusa |
|
|
azonosító
|
tabId | string |
azonosító |
|
|
Érték
|
value | string |
Érték |
Bejelentkezés
Beágyazott aláírási URL-cím létrehozása (V2)
Beágyazott aláírási URL-cím létrehozása (V2)
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Ez egy személyes aláíró?
|
isInPersonSigner | True | string |
Yes/No |
|
Hitelesítési módszer
|
authenticationMethod | True | string |
Hitelesítési módszer |
|
URL-cím visszaküldése
|
returnUrl | True | string |
URL-cím visszaküldése |
|
További hozzáadott URL-cím
|
additionalURL | True | dynamic |
További hozzáadott URL-cím. |
Válaszok
- Törzs
- EmbeddedSigningResponse
Beágyazott aláírási URL-cím létrehozása [ELAVULT]
Beágyazott aláírási URL-cím létrehozása
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Aláíró neve
|
signerName | True | string |
Aláíró neve |
|
Aláíró e-mail-címe
|
signerEmail | True | string |
Aláíró e-mail-címe |
|
Ügyfélfelhasználó azonosítója
|
clientUserId | string |
Kötelező, kivéve, ha az aláíró személyesen van. A személyes aláírók üresen hagyása |
|
|
Hitelesítési módszer
|
authenticationMethod | True | string |
Hitelesítési módszer |
|
URL-cím visszaküldése
|
returnUrl | True | string |
URL-cím visszaküldése |
|
További hozzáadott URL-cím
|
additionalURL | dynamic |
További hozzáadott URL-cím. |
Válaszok
- Törzs
- EmbeddedSigningResponse
Beágyazott feladó URL-címének létrehozása
Beágyazott feladó URL-címének létrehozása
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Megnyitás a következőben:
|
openIn | True | string |
Megnyitás a következőben: |
|
URL-cím visszaküldése
|
returnUrl | True | string |
URL-cím visszaküldése |
|
További hozzáadott URL-cím
|
additionalURL | dynamic |
További hozzáadott URL-cím. |
Válaszok
- Törzs
- EmbeddedSenderResponse
Boríték egyéni mezőinformációinak lekérése
Boríték egyéni mezőinformációinak lekérése.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Egyéni mező neve
|
fieldName | True | string |
Egyéni mező neve |
Válaszok
Boríték küldése
Küldjön egy meglévő borítékot.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
Válaszok
- response
- object
Boríték létrehozása (V2)
Hozzon létre egy új üres borítékot.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Email tárgy
|
emailSubject | True | string |
Az e-mail tárgya. |
|
body
|
body | dynamic |
E-mail törzs és fiók egyéni mezői. |
Válaszok
- Törzs
- CreateEnvelopeResponse
Boríték létrehozása sablonnal
Hozzon létre egy új borítékot egy megadott sablon használatával.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Sablon ID
|
templateId | True | string |
Adjon meg vagy válasszon ki egy sablonazonosítót. |
|
Boríték állapota
|
status | True | string |
Boríték állapota |
Válaszok
- Törzs
- CreateEnvelopeResponse
Boríték létrehozása sablonnal a címzettekkel
Hozzon létre egy új borítékot egy megadott sablon használatával, és adja meg a címzetteket.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték állapota
|
status | True | string |
Boríték állapota |
|
Sablon ID
|
templateId | True | string |
Adjon meg vagy válasszon ki egy sablonazonosítót. |
|
Aláírói
|
signers | dynamic |
A dokumentum aláírói. |
|
|
Email tárgy
|
emailSubject | string |
Email tárgy |
|
|
E-mail törzs
|
emailBody | string |
E-mail törzs |
Válaszok
- Törzs
- CreateEnvelopeResponse
Boríték létrehozása sablonnal címzettekkel és lapokkal
Boríték létrehozása sablonnal címzettekkel és lapokkal
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Sablon ID
|
templateId | True | string |
Adjon meg vagy válasszon ki egy sablonazonosítót. |
|
Címzettek
|
recipients | dynamic |
A dokumentum aláírói. |
|
|
Szerepkörök egyesítése és üres címzettek törlése
|
merge_roles_on_draft | string |
Szerepkörök egyesítése és üres címzettek törlése |
|
|
Email tárgy
|
emailSubject | string |
Email tárgy |
Válaszok
- Törzs
- CreateEnvelopeResponse
Boríték létrehozása összetett sablonok használatával
Boríték létrehozása összetett sablonok használatával
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Email tárgy
|
emailSubject | True | string |
Az e-mail tárgya. |
|
E-mail törzs
|
emailBody | string |
Az e-mail törzse. |
|
|
Boríték állapota
|
status | True | string |
Boríték állapota |
|
Szerepkörök egyesítése és üres címzettek törlése
|
merge_roles_on_draft | string |
Szerepkörök egyesítése és üres címzettek törlése |
|
|
body
|
body | dynamic |
Válaszok
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Boríték azonosítója
|
envelopeId | string |
A boríték azonosítója. |
|
Státusz
|
status | string |
A boríték állapota. |
|
Állapotdátum időpontja
|
statusDateTime | string |
Az állapot beállításának dátuma. |
|
URI
|
uri | string |
A Boríték URI-ja a DocuSignben. |
Boríték tömeges küldése sablonnal
Boríték tömeges küldése sablonnal
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Lista tömeges küldése – GUID
|
bulkSendListId | True | string |
Lista tömeges küldése – GUID |
|
Sablon ID
|
envelopeOrTemplateId | True | string |
Adja meg a sablon azonosítóját, vagy válasszon egy sablont a legördülő listából |
Válaszok
- Törzs
- BulkSendListGuid
Borítékok előtöltési lapjának frissítése
Az előtöltési lapok listájának értékeinek frissítése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Dokumentumazonosító
|
documentId | True | string |
Adjon meg egy dokumentumazonosítót. |
|
Típus
|
tabType | string |
Típus |
|
|
azonosító
|
tabId | string |
azonosító |
|
|
Érték
|
value | string |
Érték |
Borítékok listázása
Ez a művelet visszaadja a releváns Docusign-borítékokat a boríték állapota, a dátumtartomány, a címzett neve, a címzett e-mail címe, a boríték címe, a dokumentum neve vagy a boríték egyéni mezőértéke alapján. A kimenet a cím, a leírás, a boríték azonosítója, a dokumentumnevek, a feladók neve, a boríték állapota, az állapot dátuma, az elküldött dátum és a boríték URL-címe, amely hivatkozásként használható a boríték Docusignban való megtekintéséhez.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Címzett neve
|
recipientName | string |
Ez a művelet a címzett neve alapján listázza a borítékokat |
|
|
Címzett e-mail címe
|
recipientEmailId | string |
Borítékok szűrése címzett e-mail alapján |
|
|
Boríték tárgya
|
envelopeTitle | string |
Borítékok szűrése boríték tárgy szerint |
|
|
Egyéni mező neve
|
customFieldName | string |
Ez a művelet az egyéni mezők neve alapján listázza a borítékokat |
|
|
Egyéni mező értéke
|
customFieldValue | string |
Szűrők egyéni mezőérték alapján |
|
|
Keresés szóban
|
search_text | string |
Írjon be egy kulcsszót a boríték tárgyainak, címzettjeinek és egyéni mezőinek egyezéseinek kereséséhez. |
|
|
Boríték állapota
|
envelopeStatus | string |
Ez a művelet felsorolja a borítékokat a boríték állapota alapján |
|
|
Mappa
|
folder_ids | string |
Borítékok szűrése a kijelölt mappa szerint |
|
|
Megrendelés a következő szerint:
|
order_by | string |
Borítékok rendezése a kijelölt sorrendben |
|
|
Borítékok visszaküldése
|
top | integer |
Adja meg a visszaküldött borítékok számát (alapértelmezés szerint 10, maximum 1000) |
|
|
Borítékok kihagyása
|
skip | integer |
Adja meg a kezdettől kihagyandó borítékok számát |
|
|
Kezdő dátum
|
from_date | date-time |
Adja meg a kezdési dátumot UTC formátumban: 2017-05-02T01:44z |
|
|
Befejező dátum
|
to_date | date-time |
Adja meg a befejezési dátumot UTC formátumban: 2017-05-02T01:44z. |
Válaszok
Buildszám megjelenítése (csak referenciaként. Ne szerepeljen a folyamatban végrehajtás céljából)
A jelenleg üzembe helyezett build azonosítója.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Buildszám
|
buildNumber | dynamic |
Válaszok
- response
- object
Címzett adatainak lekérése borítékból
Címzett adatainak lekérése borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Címzett e-mail címe
|
recipientEmail | string |
Címzett e-mail címe |
|
|
Körzetszám
|
areaCode | string |
A címzett körzetszáma |
|
|
Telefonszám
|
phoneNumber | string |
A címzett telefonszáma |
|
|
Címzett azonosítója
|
recipientId | string |
Adjon meg egy címzett-azonosítót. |
Válaszok
- Törzs
- Signer
Címzett eltávolítása borítékból
Címzett eltávolítása borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Mappa
|
folderId | True | string |
Mappaazonosító |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Címzett azonosítója
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
Címzett azonosítója |
Válaszok
- Törzs
- ListRecipientsResponse
Címzett frissítése borítékon
Címzett frissítése borítékon
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Címzett azonosítója
|
recipientId | True | string |
Adjon meg egy címzett-azonosítót. |
|
Aláírás típusa
|
signatureType | string |
DocuSign szabványalapú aláírási (SBS-) típusok. |
|
|
Címzett típusa
|
recipientType | True | string |
Címzett típusa |
|
Ügyfélfelhasználó azonosítója
|
clientUserId | string |
Beágyazott aláíró ügyfélfelhasználói azonosítója |
|
|
Beágyazott címzett kezdő URL-címe
|
embeddedRecipientStartURL | string |
Egy feladó által megadott URL-sztring beágyazott címzett átirányításához. |
|
|
Aláírási rendelés
|
routingOrder | string |
A címzett aláírási sorrendje. |
|
|
E-mail értesítési nyelv
|
emailNotificationLanguage | string |
Az e-mail-értesítés nyelve. |
|
|
E-mail értesítés tárgya
|
emailNotificationSubject | string |
Az e-mail-értesítés tárgya. |
|
|
E-mail-értesítés törzse
|
emailNotificationBody | string |
Az e-mail-értesítés törzse. |
|
|
Megjegyzés:
|
note | string |
Egyéni megjegyzés a címzett számára. |
|
|
Szerepkör neve
|
roleName | string |
A címzetthez társított szerepkör neve. |
|
|
SMS országkód
|
countryCode | string |
SMS-értesítések esetén az országkód, bevezető + jel nélkül. |
|
|
SMS-telefonszám
|
phoneNumber | string |
Aláíró e-mail vagy SMS-telefon szükséges. A telefonszám országkódjának kizárása. |
|
|
Aláíró csoport
|
signingGroupId | string |
Aláíró csoport |
|
|
a kiválasztott címzett típusának részletei
|
additionalRecipientParams | dynamic |
A kiválasztott címzett típusának részletei. |
Válaszok
- Törzs
- Signer
Címzett hozzáadása borítékhoz (V2)
Címzett hozzáadása egy borítékhoz.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Címzett típusa
|
recipientType | True | string |
Adja meg vagy válassza ki a címzett típusát. |
|
Ügyfélfelhasználó azonosítója
|
clientUserId | string |
Beágyazott aláíró ügyfélfelhasználói azonosítója |
|
|
Címzett azonosítója
|
recipientId | string |
Adjon meg egy címzett-azonosítót. |
|
|
Beágyazott címzett kezdő URL-címe
|
embeddedRecipientStartURL | string |
Egy feladó által megadott URL-sztring beágyazott címzett átirányításához. |
|
|
Aláírási rendelés
|
routingOrder | string |
A címzett aláírási sorrendje. |
|
|
E-mail értesítési nyelv
|
emailNotificationLanguage | string |
Az e-mail-értesítés nyelve. |
|
|
E-mail értesítés tárgya
|
emailNotificationSubject | string |
Az e-mail-értesítés tárgya. |
|
|
E-mail-értesítés törzse
|
emailNotificationBody | string |
Az e-mail-értesítés törzse. |
|
|
Megjegyzés:
|
note | string |
Egyéni megjegyzés a címzett számára. |
|
|
Szerepkör neve
|
roleName | string |
A címzetthez társított szerepkör neve. |
|
|
SMS országkód
|
countryCode | string |
SMS-értesítések esetén az országkód, bevezető + jel nélkül. |
|
|
SMS-telefonszám
|
phoneNumber | string |
Aláíró e-mail vagy SMS-telefon szükséges. A telefonszám országkódjának kizárása. |
|
|
Aláíró csoport
|
signingGroupId | string |
Aláíró csoport |
|
|
Aláírás típusa
|
signatureType | string |
DocuSign szabványalapú aláírási (SBS-) típusok. |
|
|
Ellenőrzési munkafolyamat
|
workflowId | string |
Itt kell kiválasztani a tollaírás-típusokat tartalmazó IDV-munkafolyamatokat. |
|
|
a kiválasztott címzett típusának részletei
|
additionalRecipientParams | dynamic |
A kiválasztott címzett típusának részletei. |
Válaszok
- Törzs
- Signer
Címzett lapfülek lekérése borítékból
Címzett lapfülek lekérése borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Címzett azonosítója
|
recipientId | True | string |
Adjon meg egy címzett-azonosítót. |
Válaszok
- Törzs
- RecipientTabsResponse
Címzettek listázása borítékból
Címzettek listázása borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
Válaszok
- Törzs
- ListRecipientsResponse
Docusign-munkafolyamat indítása
Docusign-munkafolyamat indítása
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
munkafolyamat
|
workflowId | True | string |
Adja meg a munkafolyamat azonosítóját, vagy válassza ki a munkafolyamat nevét a legördülő listából |
|
példány neve
|
instanceName | True | string |
A munkafolyamat-példány neve |
|
változó
|
variable | dynamic |
Válaszok
TriggerMaestroFlowResponse
- response
- object
Dokumentum egyéni mezőinek lekérése borítékból
Dokumentum egyéni mezőinek lekérése borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Dokumentumazonosító
|
documentId | True | string |
Adjon meg egy dokumentumazonosítót. |
Válaszok
Dokumentumadatok lekérése borítékból
Dokumentumadatok lekérése borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Dokumentum neve
|
documentName | True | string |
Fájlnév kiterjesztéssel |
Válaszok
- Törzs
- EnvelopeDocument
Dokumentumfülek lekérése borítékból
Dokumentumfülek lekérése borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Dokumentumazonosító
|
documentId | True | string |
Adjon meg egy dokumentumazonosítót. |
Válaszok
- Törzs
- ListTabsResponse
Dokumentumfülek lekérése sablonból
Dokumentumfülek lekérése sablonból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Sablon ID
|
templateId | True | string |
Adjon meg vagy válasszon ki egy sablonazonosítót. |
|
Dokumentumazonosító
|
documentId | True | string |
Adjon meg egy dokumentumazonosítót. |
Válaszok
- Törzs
- ListTabsResponse
Dokumentumgenerálási űrlapmezők frissítése borítékból
Dokumentumgenerálási űrlapmezők frissítése borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Dokumentum GUID azonosítója
|
documentGuid | True | string |
Dokumentum GUID azonosítója |
|
Típus
|
fieldType | string |
Válassza ki a frissíteni kívánt dokumentumgenerálási mező típusát |
|
|
Név
|
name | string |
Adja meg a mező nevét vagy a tábla oszlopának nevét |
|
|
Érték
|
value | string |
Adja meg a mezőadatokat |
|
|
Címke
|
label | string |
A táblasorhoz szükséges. Adja meg a docgen mező címkéjét. |
|
|
: Tábla neve
|
tableName | string |
A táblasorhoz szükséges. Adja meg a tábla nevét. |
|
|
: Táblázatsor
|
rowNumber | string |
A táblasorhoz szükséges. Adja meg a sorszámot |
Dokumentumgenerálási űrlapmezők lekérése borítékból
Dokumentumgenerálási űrlapmezők lekérése borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
Válaszok
- Törzs
- DocGenFormFieldsResponse
Dokumentumgenerálási űrlapmezők lekérése sablonból (csak tömeges sablonküldés)
Dokumentumgenerálási űrlapmezők lekérése sablonból (csak tömeges sablonküldés)
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Sablon ID
|
templateId | True | string |
Adjon meg vagy válasszon ki egy sablonazonosítót. |
Válaszok
Dokumentumgenerálási űrlapmezők a sablonból
- DocGen-sablonmezők
- object
Dokumentumok hozzáadása borítékhoz
Dokumentumok hozzáadása borítékhoz.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Document Base64 *
|
documentBase64 | True | string |
Dokumentumtartalmak alap64-es listája |
|
Dokumentumtípus *
|
fileExtension | True | string |
pdf, docx stb. |
|
Dokumentum neve *
|
name | True | string |
dokumentum neve |
|
Pdf-mezők átalakítása
|
transformPdfFields | string |
Téves |
|
|
Lapok hozzárendelése címzetthez
|
assignTabsToRecipientId | string |
Címzett azonosítója |
Válaszok
- Törzs
- AddDocumentsResponse
Dokumentumok lekérése borítékból
Dokumentumok lekérése borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Kimeneti formátum
|
documentId | True | string |
Egyetlen dokumentum lekéréséhez vagy formátum kiválasztásához írja be a "sztring(dokumentumazonosító)" kifejezést. |
|
Befejezési nyelv tanúsítványa (nem kötelező)
|
language | string |
Nyelv kiválasztása |
Válaszok
- response
- GetDocumentsResponse
Dokumentumok listázása borítékból
Dokumentumok listázása borítékból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
Válaszok
- Törzs
- ListDocumentsResponse
Dokumentumok listázása sablonból
Dokumentumok listázása sablonból
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Sablon ID
|
templateId | True | string |
Adjon meg vagy válasszon ki egy sablonazonosítót. |
Válaszok
Egyéni boríték mező frissítése
A megadott egyéni borítékmező értékének frissítése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Mezőazonosító
|
fieldId | True | string |
Egyéni mezőazonosító |
|
Mezőtípus
|
fieldType | True | string |
Egyéni mezőtípus |
|
Név
|
name | True | string |
Egyéni mező neve |
|
Érték
|
value | True | string |
Egyéni mező értéke |
Válaszok
ELAVULT: Boríték létrehozása sablonnal (elavult) [ELAVULT]
Hozzon létre egy új borítékot egy megadott sablon használatával (elavult).
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Sablon ID
|
templateId | True | string |
Adjon meg vagy válasszon ki egy sablonazonosítót. |
|
Boríték állapota
|
status | True | string |
Boríték állapota |
|
Egyéni mezők
|
accountCustomFields | True | dynamic |
Kérje le a fiók szintjén beállított egyéni mezőket. |
Válaszok
- Törzs
- CreateEnvelopeResponse
ELAVULT: Címzett hozzáadása borítékhoz (elavult) [ELAVULT]
Címzett hozzáadása borítékhoz (elavult).
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Fiókazonosító |
|
Boríték
|
envelopeId | True | string |
Boríték azonosítója |
|
Aláíró neve
|
AddRecipientToEnvelopeName | True | string |
A címzett neve. |
|
Aláíró e-mail-címe
|
AddRecipientToEnvelopeEmail | True | string |
A címzett e-mail címe. |
|
Aláírási rendelés
|
routingOrder | string |
A címzett aláírási sorrendje a dokumentumban. |
|
|
Role
|
roleName | string |
Az aláíró szerepe. |
Válaszok
- Törzs
- ListRecipientsResponse
ELAVULT: Dokumentumok lekérése borítékból (elavult) [ELAVULT]
Dokumentumok lekérése borítékból (elavult)
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Fiókazonosító |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Tanúsítvány a befejezésről
|
certificate | True | boolean |
Ha hamis értékre van állítva, a rendszer eltávolítja a boríték-aláíró tanúsítványt a letöltésből. |
Válaszok
- response
- GetDocumentsResponse
Ellenőrzési típus hozzáadása címzetthez
Adjon hozzá ellenőrzési típust egy címzetthez.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Címzett azonosítója
|
recipientId | True | string |
Adjon meg egy címzett-azonosítót. |
|
Címzett típusa
|
recipientType | True | string |
Adja meg vagy válassza ki a címzett típusát. |
|
Ellenőrzési típus
|
verificationType | True | string |
Ellenőrzési típus |
|
További címzettadatok
|
additionalRecipientData | dynamic |
További címzettadatok. |
Emlékeztetők hozzáadása borítékhoz
Emlékeztetők hozzáadása borítékhoz
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Emlékeztető engedélyezve
|
reminderEnabled | True | boolean |
Ha hamisra van állítva, az emlékeztetők le vannak tiltva. Az alapértelmezett érték hamis |
|
Emlékeztető késleltetése
|
reminderDelay | True | string |
Adja meg azt a napok számát, amelyek után a címzett emlékeztető e-mailt kap. |
|
Emlékeztető gyakorisága
|
reminderFrequency | True | string |
Adja meg az emlékeztető e-mailek közötti napok számát. |
|
Lejárat után
|
expireAfter | string |
Adja meg a lejárat előtti napok számát. |
Válaszok
- Törzs
- AddRemindersResponse
Lapfülek hozzáadása egy címzetthez egy borítékon
Lapfülek hozzáadása egy címzetthez egy borítékon
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Címzett azonosítója
|
recipientId | True | string |
Adjon meg egy címzett-azonosítót. |
|
Tabulátor típusa
|
tabType | True | string |
Tabulátor típusa |
|
tabulátor részletei
|
tabDetails | True | dynamic |
A kijelölt horgonylap részletei. |
Válaszok
- Törzs
- AddRecipientTabsResponse
Listasablonok
Adott fiók sablonjainak listázása.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
Válaszok
- Törzs
- ListTemplatesResponse
Naplózási eseménylista lekérése
Naplózási eseménylista lekérése
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
Válaszok
- response
- object
Sablon alkalmazása dokumentumokra
Sablon alkalmazása dokumentumokra
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Boríték azonosítója
|
envelopeId | True | string |
Adja meg a boríték azonosítóját. |
|
Sablon ID
|
templateId | True | string |
Adjon meg vagy válasszon ki egy sablonazonosítót. |
|
Sablon címzettjének megőrzése
|
preserve_template_recipient | string |
Téves |
|
|
Dokumentumazonosító
|
documentId | True | string |
Dokumentumazonosító |
|
Dokumentum kezdőlapja
|
documentStartPage | True | string |
Dokumentum kezdőlapja |
|
Dokumentum záróoldala
|
documentEndPage | True | string |
Dokumentum záróoldala |
Tömeges küldési lista létrehozása
Tömeges küldési lista létrehozása
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg vagy válasszon ki egy fiókazonosítót. |
|
Listanév tömeges küldése
|
name | True | string |
Listanév tömeges küldése |
|
CSV-fájl
|
csv | string |
CSV-fájl feltöltése |
|
|
Dokumentumgenerálási mezők
|
rawOutput | object |
Dokumentumgenerálási mezők |
Válaszok
- Törzs
- BulkSendListGuid
Triggerek
| Amikor egy boríték állapota megváltozik (Csatlakozás) (V3) |
Új folyamatot aktivál, amikor megváltozik a boríték állapota. |
| Docusign Connect-esemény bekövetkezésekor (fiókszintű) |
Új folyamatot aktivál, amikor megváltozik a boríték állapota. |
| Docusign Connect-esemény bekövetkezésekor (szervezeti szintű) |
Új folyamatot aktivál, amikor megváltozik a boríték állapota. |
| ELAVULT: Ha egy boríték állapota megváltozik (Csatlakozás) (elavult) [ELAVULT] |
Új folyamatot indít el, amikor egy boríték állapota megváltozik (elavult). |
| ELAVULT: Ha egy boríték állapota megváltozik (Csatlakozás) (V2) (elavult) [ELAVULT] |
Új folyamatot indít el, amikor egy boríték állapota megváltozik (elavult). |
Amikor egy boríték állapota megváltozik (Csatlakozás) (V3)
Új folyamatot aktivál, amikor megváltozik a boríték állapota.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Fiókazonosító |
|
Csatlakozás neve
|
name | True | string | |
|
Borítékesemény
|
envelopeEvents | True | string |
Válaszok
Docusign Connect-esemény bekövetkezésekor (fiókszintű)
Új folyamatot aktivál, amikor megváltozik a boríték állapota.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Fiókazonosító
|
accountId | True | string |
Adjon meg egy fiókazonosítót, vagy válasszon ki egy fiókot a legördülő listából. |
|
Konfigurációnév csatlakoztatása
|
name | True | string |
Nevezze el a Connect-konfigurációt (például "Borítékesemények"). |
|
Kiváltó események
|
events | True | array of string |
Válasszon ki egy eseményt. Egy másik esemény hozzáadásához válassza az "Új elem hozzáadása" lehetőséget. |
Válaszok
Docusign Connect-esemény bekövetkezésekor (szervezeti szintű)
Új folyamatot aktivál, amikor megváltozik a boríték állapota.
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Szervezeti azonosító
|
organizationId | True | string |
Adjon meg vagy válasszon ki egy szervezeti azonosítót. |
|
Konfigurációnév csatlakoztatása
|
name | True | string |
Nevezze el a Connect-konfigurációt (például "Borítékesemények"). |
|
Kiváltó események
|
events | True | array of string |
Válasszon ki egy eseményt. Egy másik esemény hozzáadásához válassza az "Új elem hozzáadása" lehetőséget. |
Válaszok
ELAVULT: Ha egy boríték állapota megváltozik (Csatlakozás) (elavult) [ELAVULT]
Új folyamatot indít el, amikor egy boríték állapota megváltozik (elavult).
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Fiókazonosító |
|
Csatlakozás neve
|
name | True | string | |
|
Borítékesemény
|
envelopeEvents | True | string |
Válaszok
- Törzs
- WebhookEnvelopeResponse
ELAVULT: Ha egy boríték állapota megváltozik (Csatlakozás) (V2) (elavult) [ELAVULT]
Új folyamatot indít el, amikor egy boríték állapota megváltozik (elavult).
Paraméterek
| Name | Kulcs | Kötelező | Típus | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Fiókazonosító |
|
Csatlakozás neve
|
name | True | string | |
|
Borítékesemény
|
envelopeEvents | True | string |
Válaszok
Definíciók
WebhookEnvelopeResponseV2
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Egyéni mezők
|
data.envelopeSummary.customFields | object |
A boríték egyéni mezőit képviselő kulcs-érték párok (ahol a kulcs a mező neve, az érték pedig a mező értéke). |
|
Boríték létrehozva Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Boríték azonosítója
|
data.envelopeSummary.envelopeId | string | |
|
Boríték elküldve Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Boríték állapota
|
data.envelopeSummary.status | string | |
|
E-mail tárgy
|
data.envelopeSummary.emailSubject | string | |
|
Feladó neve
|
data.envelopeSummary.sender.userName | string | |
|
Feladó felhasználói azonosítója
|
data.envelopeSummary.sender.userId | string | |
|
Feladó fiókazonosítója
|
data.envelopeSummary.sender.accountId | string | |
|
Feladó e-mail-címe
|
data.envelopeSummary.sender.email | string | |
|
Aláírói
|
data.envelopeSummary.recipients.signers | array of object | |
|
Lapfülek
|
data.envelopeSummary.recipients.signers.tabs | object |
Kulcs-érték párok, amelyek a címzett lapjait jelölik (ahol a kulcs a mező neve, az érték pedig a mező értéke). |
|
Címzett e-mail címe
|
data.envelopeSummary.recipients.signers.email | string | |
|
Címzett azonosítója
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Útválasztási sorrend
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Címzett küldése Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Címzett állapota
|
data.envelopeSummary.recipients.signers.status | string |
A címzett állapota. |
|
Címzett típusa
|
data.envelopeSummary.recipients.signers.recipientType | string |
A címzett típusa. |
|
Ellenőrzési típus
|
data.envelopeSummary.recipients.signers.verificationType | string |
Az ellenőrzés típusa. |
|
Címzett neve
|
data.envelopeSummary.recipients.signers.name | string |
A címzett neve. |
WebhookEnvelopeResponseV3
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Egyéni mezők
|
data.envelopeSummary.customFields | object |
A boríték egyéni mezőit képviselő kulcs-érték párok (ahol a kulcs a mező neve, az érték pedig a mező értéke). |
|
Boríték létrehozva Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Boríték azonosítója
|
data.envelopeSummary.envelopeId | string | |
|
Boríték elküldve Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Boríték állapota
|
data.envelopeSummary.status | string | |
|
E-mail tárgy
|
data.envelopeSummary.emailSubject | string | |
|
Feladó neve
|
data.envelopeSummary.sender.userName | string | |
|
Feladó felhasználói azonosítója
|
data.envelopeSummary.sender.userId | string | |
|
Feladó fiókazonosítója
|
data.envelopeSummary.sender.accountId | string | |
|
Feladó e-mail-címe
|
data.envelopeSummary.sender.email | string | |
|
Aláírói
|
data.envelopeSummary.recipients.signers | array of object | |
|
Lapfülek
|
data.envelopeSummary.recipients.signers.tabs | object |
Kulcs-érték párok, amelyek a címzett lapjait jelölik (ahol a kulcs a mező neve, az érték pedig a mező értéke). |
|
Címzett e-mail címe
|
data.envelopeSummary.recipients.signers.email | string | |
|
Címzett azonosítója
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Útválasztási sorrend
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Címzett küldése Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Címzett állapota
|
data.envelopeSummary.recipients.signers.status | string |
A címzett állapota. |
|
Címzett típusa
|
data.envelopeSummary.recipients.signers.recipientType | string |
A címzett típusa. |
|
Ellenőrzési típus
|
data.envelopeSummary.recipients.signers.verificationType | string |
Az ellenőrzés típusa. |
|
Címzett neve
|
data.envelopeSummary.recipients.signers.name | string |
A címzett neve. |
WebhookEnvelopeResponseV4
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Boríték egyéni mezői
|
data.envelopeSummary.customFields | object |
A boríték egyéni mezőit képviselő kulcs-érték párok (ahol a kulcs a mező neve, az érték pedig a mező értéke). |
|
Boríték létrehozva Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Boríték azonosítója
|
data.envelopeSummary.envelopeId | string | |
|
Boríték elküldve Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Boríték állapota
|
data.envelopeSummary.status | string | |
|
E-mail tárgy
|
data.envelopeSummary.emailSubject | string | |
|
borítékDocuments
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
Dokumentumazonosító
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Dokumentum guid azonosítója
|
data.envelopeSummary.envelopeDocuments.documentIdGuid | string | |
|
Dokumentum neve
|
data.envelopeSummary.envelopeDocuments.name | string | |
|
Feladó neve
|
data.envelopeSummary.sender.userName | string | |
|
Feladó felhasználói azonosítója
|
data.envelopeSummary.sender.userId | string | |
|
Feladó fiókazonosítója
|
data.envelopeSummary.sender.accountId | string | |
|
Feladó e-mail-címe
|
data.envelopeSummary.sender.email | string | |
|
Aláírói
|
data.envelopeSummary.recipients.signers | array of object | |
|
Lapfülek
|
data.envelopeSummary.recipients.signers.tabs | object |
Kulcs-érték párok, amelyek a címzett lapjait jelölik (ahol a kulcs a mező neve, az érték pedig a mező értéke). |
|
Címzett e-mail címe
|
data.envelopeSummary.recipients.signers.email | string | |
|
Címzett azonosítója
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Útválasztási sorrend
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Címzett küldése Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Címzett állapota
|
data.envelopeSummary.recipients.signers.status | string |
A címzett állapota. |
|
Címzett típusa
|
data.envelopeSummary.recipients.signers.recipientType | string |
A címzett típusa. |
|
Ellenőrzési típus
|
data.envelopeSummary.recipients.signers.verificationType | string |
Az ellenőrzés típusa. |
|
Címzett neve
|
data.envelopeSummary.recipients.signers.name | string |
A címzett neve. |
WebhookOrganizationResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Szervezeti azonosító
|
data.organizationId | string |
A szervezet azonosítója. |
|
Egyéni mezők
|
data.envelopeSummary.customFields | object |
A boríték egyéni mezőit képviselő kulcs-érték párok (ahol a kulcs a mező neve, az érték pedig a mező értéke). |
|
Boríték létrehozva Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Boríték azonosítója
|
data.envelopeSummary.envelopeId | string | |
|
Boríték elküldve Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Boríték állapota
|
data.envelopeSummary.status | string | |
|
E-mail tárgy
|
data.envelopeSummary.emailSubject | string | |
|
borítékDocuments
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
Dokumentumazonosító
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Dokumentum guid azonosítója
|
data.envelopeSummary.envelopeDocuments.documentIdGuid | string | |
|
Dokumentum neve
|
data.envelopeSummary.envelopeDocuments.name | string | |
|
Feladó neve
|
data.envelopeSummary.sender.userName | string | |
|
Feladó felhasználói azonosítója
|
data.envelopeSummary.sender.userId | string | |
|
Feladó fiókazonosítója
|
data.envelopeSummary.sender.accountId | string | |
|
Feladó e-mail-címe
|
data.envelopeSummary.sender.email | string | |
|
Aláírói
|
data.envelopeSummary.recipients.signers | array of object | |
|
Lapfülek
|
data.envelopeSummary.recipients.signers.tabs | object |
Kulcs-érték párok, amelyek a címzett lapjait jelölik (ahol a kulcs a mező neve, az érték pedig a mező értéke). |
|
Címzett e-mail címe
|
data.envelopeSummary.recipients.signers.email | string | |
|
Címzett azonosítója
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Útválasztási sorrend
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Címzett küldése Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Címzett állapota
|
data.envelopeSummary.recipients.signers.status | string |
A címzett állapota. |
|
Címzett típusa
|
data.envelopeSummary.recipients.signers.recipientType | string |
A címzett típusa. |
|
Ellenőrzési típus
|
data.envelopeSummary.recipients.signers.verificationType | string |
Az ellenőrzés típusa. |
|
Címzett neve
|
data.envelopeSummary.recipients.signers.name | string |
A címzett neve. |
WebhookEnvelopeResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Boríték egyéni mezői
|
customFields | object |
A boríték egyéni mezőit képviselő kulcs-érték párok (ahol a kulcs a mező neve, az érték pedig a mező értéke). |
|
Boríték létrehozva Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Feladó e-mail-címe
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
Boríték azonosítója
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
Feladó IP-címe
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
Boríték elküldve Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Boríték állapota
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
Tárgy
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
Feladó neve
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
RecipientStatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
Lapfülek
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
Kulcs-érték párok, amelyek a címzett lapjait jelölik (ahol a kulcs a mező neve, az érték pedig a mező értéke). |
|
Elutasítás oka
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
Címzett e-mail címe
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
Címzett azonosítója
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
Útválasztási sorrend
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
Címzett küldése Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Címzett állapota
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
A címzett állapota. |
|
Címzett típusa
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
A címzett típusa. |
|
Címzett neve
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
A címzett neve. |
|
Időzóna
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
Időzóna eltolása
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocumentsResponse
- Fájl tartalma
- binary
AddRemindersResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Emlékeztető engedélyezve
|
reminderEnabled | string |
Emlékeztető engedélyezve |
FilteredEnvelopes
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Cím
|
title | string |
A boríték címe |
|
Description
|
description | string |
A borítéktevékenység leírása |
|
Boríték azonosítója
|
envelopeId | string |
Boríték azonosítója |
|
Documents
|
documents | string |
Dokumentumnevek listája |
|
Címzettek nevei
|
recipients | string |
Címzettek neveinek listája |
|
Feladó neve
|
sender | string |
Feladó neve |
|
Státusz
|
status | string |
A boríték állapota |
|
Állapot dátuma
|
statusDate | string |
A tevékenység utolsó állapotfrissítése |
|
Elküldött dátum
|
dateSent | date-time |
Boríték elküldésének dátuma |
|
URL
|
url | string |
A boríték URL-címe |
EmbeddedSenderResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Beágyazott feladó URL-címe
|
url | string |
A beágyazott feladó nézet URL-címe. |
EmbeddedSigningResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
URL
|
url | string |
A beágyazott aláíró nézet URL-címe. |
FilteredEnvelopeListResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Szűrt borítékok
|
value | array of FilteredEnvelopes |
Szűrt borítékok |
|
További borítékeredmények
|
hasMoreResults | boolean |
Azt jelzi, hogy a borítékok túllépik-e a megadott számot a Borítékok visszaküldése mezőben |
CreateEnvelopeResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Boríték azonosítója
|
envelopeId | string |
A boríték azonosítója. |
|
Sablon azonosítója
|
templateId | string |
A sablon azonosítója. |
|
Státusz
|
status | string |
A boríték állapota. |
|
Állapotdátum időpontja
|
statusDateTime | string |
Az állapot beállításának dátuma. |
|
URI
|
uri | string |
A Boríték URI-ja a DocuSignben. |
ListRecipientsResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Boríték azonosítója
|
envelopeId | string | |
|
Aláírói
|
signers | array of Signer |
Aláírói |
Tab
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Tabulátor neve
|
name | string |
A lap neve. |
|
Tabulátor típusa
|
tabType | string |
A lap típusa. |
|
Lapcímke
|
tabLabel | string |
A lap felirata. |
|
Tabulátorérték
|
value | string |
A lap értéke. |
|
Lap azonosítója
|
tabId | string |
A lap azonosítója. |
|
Dokumentumazonosító
|
documentId | string |
A dokumentum azonosítója. |
|
Címzett azonosítója
|
recipientId | string |
A címzett azonosítója. |
|
Előre kitöltés
|
prefill | boolean |
Azt jelzi, hogy a lap kitöltés előtti típusú-e. |
|
Kiválasztott
|
selected | string |
Ha a tabulátorok jelölőnégyzet be van jelölve, jelzi, hogy a lap ki van-e jelölve. |
RecipientTabsResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Címzett lap:
|
recipientTabs | array of Tab |
Címzett lap |
Aláíró
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Aláírási rendelés
|
routingOrder | string |
A címzett aláírási sorrendje a dokumentumban. |
|
Role
|
roleName | string |
Az aláíró szerepe. |
|
Címzett azonosítója
|
recipientId | string |
A címzett azonosítója. |
|
Név
|
name | string |
A címzett neve. |
|
Email
|
string |
A címzett e-mail címe. |
|
|
Címzett típusa
|
recipientType | string |
Írja be a címzettet. |
|
Ellenőrzési típus
|
verificationType | string |
Az ellenőrzés típusa. |
|
Címzett GUID azonosítója
|
recipientIdGuid | string |
A címzett GUID azonosítója. |
GetLoginAccountsResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Bejelentkezési fiókok
|
loginAccounts | array of LoginAccount |
Bejelentkezési fiókok |
LoginAccount
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Név
|
name | string |
A fiók neve. |
|
Fiókazonosító guidja
|
accountIdGuid | string |
A fiók GUID azonosítója. |
ListTabsResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Lapfülek
|
tabs | array of Tab |
Lapfülek |
ListEnvelopeDocumentFieldsResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Egyéni mező
|
envelopeDocumentFields | array of EnvelopeDocumentField |
Dokumentum egyéni mezői |
DocGenFormFieldsResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Docgen-mezők
|
docgenFields | array of DocGenFormField |
Docgen-mezők |
DocGenFormField
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Dokumentumazonosító
|
documentId | string |
Dokumentumazonosító. |
|
Címke
|
label | string |
Címke. |
|
Típus
|
type | string |
Típus. |
|
Név
|
name | string |
Név. |
|
Érték
|
value | string |
Érték. |
ListTemplatesResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Borítéksablonok
|
envelopeTemplates | array of EnvelopeTemplate |
Az elérhető borítéksablonok. |
EnvelopeTemplate
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Sablon azonosítója
|
templateId | string |
A sablon azonosítója. |
|
Név
|
name | string |
A sablon neve. |
BulkSendListGuid
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Lista tömeges küldése guid
|
listId | string |
Tömeges küldési lista guidja |
EnvelopeCustomFieldResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Mezőazonosító
|
fieldId | string |
A boríték egyéni mezőjének azonosítója. |
|
Mezőtípus
|
fieldType | string |
A boríték egyéni mezőjének típusa. |
|
Név
|
name | string |
A boríték egyéni mezőjének neve. |
|
Érték
|
value | string |
A boríték egyéni mezőjének értéke. |
UpdateEnvelopeCustomFieldResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Mezőazonosító
|
fieldId | string |
A boríték egyéni mezőjének azonosítója. |
|
Mezőtípus
|
fieldType | string |
A boríték egyéni mezőjének típusa. |
|
Név
|
name | string |
A boríték egyéni mezőjének neve. |
|
Érték
|
value | string |
A boríték egyéni mezőjének értéke. |
ListDocumentsResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Borítékdokumentumok
|
envelopeDocuments | array of EnvelopeDocument |
A borítékhoz csatolt dokumentumok. |
ListTemplateDocumentsResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Sablondokumentumok
|
templateDocuments | array of EnvelopeDocument |
Sablonhoz csatolt dokumentumok. |
AddDocumentsResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Boríték azonosítója
|
envelopeId | string |
A boríték azonosítója. |
|
Borítékdokumentumok
|
envelopeDocuments | array of EnvelopeDocument |
A borítékhoz csatolt dokumentumok. |
AddRecipientTabsResponse
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Címzettek lapjai
|
recipientTabs | array of RecipientTab |
A címzetthez hozzáadott lapok. |
Borítékdokument
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Név
|
name | string |
A dokumentum neve. |
|
Dokumentumazonosító
|
documentId | string |
A dokumentum azonosítója. |
|
Dokumentum guid azonosítója
|
documentIdGuid | string |
A dokumentum guid azonosítója. |
RecipientTab
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Lap azonosítója
|
tabId | string |
A lap azonosítója. |
|
Tabulátor típusa
|
tabType | string |
A lap típusa. |
EnvelopeDocumentField
| Name | Elérési út | Típus | Description |
|---|---|---|---|
|
Név
|
name | string |
Az egyéni mező neve. |
|
Érték
|
value | string |
Az egyéni mező értéke. |
DeclineReasonWithoutType
objektum
Ez az "objektum" típus.