Ukázka Docusignu (Preview)
Docusign umožňuje organizacím vytvářet, zavázat a spravovat své smlouvy v celém životním cyklu smlouvy. Zákazníci můžou zrychlit výnosy, snížit riziko a odemykat hodnotu ze smluv, které provozují svou firmu. Konektor Docusign Demo se připojuje jenom k ukázkovým prostředím Docusign, ale nabízí stejné funkce jako produkční konektor DocuSign. Jakékoli smlouvy v ukázkovém prostředí Docusign nejsou právně závazné.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Všechny oblasti Power Automate kromě následujících: – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logické aplikace | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Azure oblasti Čína - Ministerstvo obrany USA (DoD) |
| Power Apps | Standard | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Automatizace napájení | Standard | Všechny oblasti Power Automate kromě následujících: – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | docusign |
| URL | https://support.docusign.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | DocuSign, Inc. |
| Internetová stránka | https://www.docusign.com |
| Zásady ochrany osobních údajů | https://www.docusign.com/company/privacy-policy |
| Kategorie | Obsah a soubory; Produktivita |
Title
DocuSign pomáhá organizacím propojit a automatizovat způsob přípravy, podepisování, jednání a správy smluv. Konektor DocuSign Demo se připojuje jenom k prostředím DocuSign Demo, ale nabízí stejné funkce jako běžný konektor DocuSign. Žádné dokumenty v prostředí DocuSign Demo nejsou právně závazné. Pro všechny jiné než ukázkové použití použijte běžný konektor DocuSign.
Požadavky
Pokud chcete v této integraci použít trigger Connect, musí být v účtu DocuSign Povolená služba DocuSign Connect. Ve výchozím nastavení není povolená. Po povolení je stránka Nastavení připojení přístupná z webové aplikace DocuSign Admin. Použití triggeru Connect v této integraci automaticky zaregistruje webhook za vás.
Získání přihlašovacích údajů
Pokud chcete konektor vyzkoušet, použijte účet DEMO:
- Přejděte na https://developers.docusign.com/.
- Vytvořte účet sandboxu.
Liší se od bezplatných zkušebních verzí v tom, že nikdy nevyprší platnost, mají 90% našich placených funkcí účtu a žádný z dokumentů odesílaných prostřednictvím DEMO není právně závazný (https://support.docusign.com/en/articles/Free-account-vs-Developer-account).
Dokumentace ke konektoru
Podrobnou dokumentaci týkající se konektoru najdete v tématu https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
Známé problémy a omezení
V případě problémů s DocuSignem zkuste nejprve tento odkaz: https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center.
Pokyny k nasazení
K nasazení tohoto konektoru jako vlastního konektoru v Microsoft Power Automate a Power Apps použijte těsné pokyny.
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 250 | 60 sekund |
Akce
| Aktualizace hodnot karet příjemců na obálce |
Aktualizace hodnot karet příjemců na obálce |
| Aktualizace karet předvyplnění obálek |
Aktualizace hodnot pro seznam karet předvyplnění |
| Aktualizace polí formuláře generování dokumentů z obálky |
Aktualizace polí formuláře generování dokumentů z obálky |
| Aktualizace příjemce na obálce |
Aktualizace příjemce na obálce |
| Aktualizace vlastního pole obálky |
Aktualizace hodnoty pro zadané vlastní pole obálky |
| Generování vložené podpisové adresy URL (V2) |
Generování vložené podpisové adresy URL (V2) |
| Hromadné odeslání obálky pomocí šablony |
Hromadné odeslání obálky pomocí šablony |
| Odebrání příjemce z obálky |
Odebrání příjemce z obálky |
| Odeslat obálku |
Odeslat existující obálku |
| Použití šablony u dokumentů |
Použití šablony u dokumentů |
| Přidání dokumentů do obálky |
Přidejte dokumenty do obálky. |
| Přidání karet pro příjemce na obálku |
Přidání karet pro příjemce na obálku |
| Přidání připomenutí obálky |
Přidání připomenutí obálky |
| Přidání příjemce do obálky (V2) |
Přidejte příjemce na obálku. |
| Přidání typu ověření k příjemci |
Přidejte typ ověření k příjemci. |
| Přihlášení do systému |
Přihlášení do systému |
| Spuštění pracovního postupu Docusign |
Spuštění pracovního postupu Docusign |
| Void the obálka |
Vynulujte obálku. |
| Vygenerovat vloženou adresu URL odesílatele |
Vygenerovat vloženou adresu URL odesílatele |
| Vygenerovat vloženou podpisovou adresu URL [ZASTARALÉ] |
Generování vložené podpisové adresy URL |
| Vytvoření obálky (V2) |
Vytvořte novou prázdnou obálku. |
| Vytvoření obálky pomocí složených šablon |
Vytvoření obálky pomocí složených šablon |
| Vytvoření obálky pomocí šablony |
Vytvořte novou obálku pomocí zadané šablony. |
| Vytvoření obálky pomocí šablony s příjemci |
Vytvořte novou obálku pomocí zadané šablony a zadejte příjemce. |
| Vytvoření obálky pomocí šablony s příjemci a kartami |
Vytvoření obálky pomocí šablony s příjemci a kartami |
| Vytvoření seznamu hromadného odeslání |
Vytvoření seznamu hromadného odeslání |
| Výpis dokumentů z obálky |
Výpis dokumentů z obálky |
| Výpis dokumentů ze šablony |
Výpis dokumentů ze šablony |
| Výpis obálek |
Tato akce vrátí relevantní obálky Docusignu na základě stavu obálky, rozsahu kalendářních dat, jména příjemce, e-mailové adresy příjemce, názvu obálky, názvu dokumentu nebo hodnoty vlastního pole obálky. Výstupem je název, popis, ID obálky, názvy dokumentů, jména odesílatelů, stav obálky, datum odeslání a adresa URL obálky, která se dá použít jako odkaz k zobrazení obálky v Docusignu. |
| Výpis příjemců z obálky |
Výpis příjemců z obálky |
| Výpis šablon |
Vytvořte seznam šablon pro konkrétní účet. |
| ZASTARALÉ: Přidání příjemce do obálky (zastaralé) [ZASTARALÉ] |
Přidání příjemce do obálky (zastaralé) |
| ZASTARALÉ: Vytvoření obálky pomocí šablony (zastaralé) [ZASTARALÉ] |
Vytvořte novou obálku pomocí zadané šablony (zastaralé). |
| ZASTARALÉ: Získání dokumentů z obálky (zastaralé) [ZASTARALÉ] |
Získání dokumentů z obálky (zastaralé) |
| Znovu odeslat obálku |
Tato akce znovu odešle obálku Docusignu nebo pošle připomenutí příjemcům, kteří potřebují podepsat smlouvu Docusign na základě zadaného ID obálky. |
| Zobrazit číslo sestavení (pouze pro referenci. Nezahrnujte do toku pro spuštění) |
Identifikátor aktuálně nasazeného sestavení. |
| Získání dokumentů z obálky |
Získání dokumentů z obálky |
| Získání informací o dokumentu z obálky |
Získání informací o dokumentu z obálky |
| Získání informací o příjemci z obálky |
Získání informací o příjemci z obálky |
| Získání informací o vlastním poli obálky |
Získejte informace o vlastním poli obálky. |
| Získání informací pro kartu příjemce |
Vrátí hodnotu karty daného příjemce. |
| Získání karet dokumentu z obálky |
Získání karet dokumentu z obálky |
| Získání karet dokumentů ze šablony |
Získání karet dokumentů ze šablony |
| Získání karet příjemců z obálky |
Získání karet příjemců z obálky |
| Získání polí formuláře generování dokumentu z obálky |
Získání polí formuláře generování dokumentu z obálky |
| Získání polí formuláře generování dokumentů ze šablony (pouze šablony hromadného odesílání) |
Získání polí formuláře generování dokumentů ze šablony (pouze šablony hromadného odesílání) |
| Získání seznamu událostí auditu |
Získání seznamu událostí auditu |
| Získání vlastních polí dokumentu z obálky |
Získání vlastních polí dokumentu z obálky |
Aktualizace hodnot karet příjemců na obálce
Aktualizace hodnot karet příjemců na obálce
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID příjemce
|
recipientId | True | string |
Zadejte ID příjemce. |
|
Typ
|
tabType | string |
Typ tabulátoru |
|
|
ID
|
tabId | string |
ID |
|
|
Hodnota
|
value | string |
Hodnota |
Aktualizace karet předvyplnění obálek
Aktualizace hodnot pro seznam karet předvyplnění
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID dokumentu
|
documentId | True | string |
Zadejte ID dokumentu. |
|
Typ
|
tabType | string |
Typ |
|
|
ID
|
tabId | string |
ID |
|
|
Hodnota
|
value | string |
Hodnota |
Aktualizace polí formuláře generování dokumentů z obálky
Aktualizace polí formuláře generování dokumentů z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Identifikátor GUID dokumentu
|
documentGuid | True | string |
Identifikátor GUID dokumentu |
|
Typ
|
fieldType | string |
Zvolte typ pole generování dokumentu, které chcete aktualizovat. |
|
|
Název
|
name | string |
Zadejte název pole nebo název sloupce tabulky. |
|
|
Hodnota
|
value | string |
Zadejte data pole. |
|
|
Označení
|
label | string |
Požadováno pro řádek tabulky. Zadejte popisek pole docgen. |
|
|
: Název tabulky
|
tableName | string |
Požadováno pro řádek tabulky. Zadejte název tabulky. |
|
|
: Řádek tabulky
|
rowNumber | string |
Požadováno pro řádek tabulky. Zadejte číslo řádku. |
Aktualizace příjemce na obálce
Aktualizace příjemce na obálce
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID příjemce
|
recipientId | True | string |
Zadejte ID příjemce. |
|
Typ podpisu
|
signatureType | string |
Typy podpisů založených na standardech DocuSign (SBS). |
|
|
Typ příjemce
|
recipientType | True | string |
Typ příjemce |
|
ID uživatele klienta
|
clientUserId | string |
ID uživatele klienta pro vložené podepisující osoby |
|
|
Vložená počáteční adresa URL příjemce
|
embeddedRecipientStartURL | string |
Řetězec adresy URL poskytnuté odesílatelem pro přesměrování vloženého příjemce. |
|
|
Podpisová objednávka
|
routingOrder | string |
Podpisová objednávka příjemce. |
|
|
Jazyk e-mailových oznámení
|
emailNotificationLanguage | string |
Jazyk e-mailového oznámení |
|
|
Předmět e-mailového oznámení
|
emailNotificationSubject | string |
Předmět e-mailového oznámení |
|
|
Text e-mailového oznámení
|
emailNotificationBody | string |
Text e-mailového oznámení |
|
|
Poznámka:
|
note | string |
Vlastní poznámka pro příjemce |
|
|
Název role
|
roleName | string |
Název role přidružený k příjemci |
|
|
Směrové číslo země SMS
|
countryCode | string |
Pro sms oznámení, kód země bez úvodní + znaménko. |
|
|
Telefonní číslo SMS
|
phoneNumber | string |
Vyžaduje se e-mail podepisující osoby nebo telefon SMS. Vylučte kód země pro telefonní číslo. |
|
|
Podpisová skupina
|
signingGroupId | string |
Podpisová skupina |
|
|
podrobnosti o vybraném typu příjemce
|
additionalRecipientParams | dynamic |
Podrobnosti pro vybraný typ příjemce |
Návraty
- Body
- Signer
Aktualizace vlastního pole obálky
Aktualizace hodnoty pro zadané vlastní pole obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID pole
|
fieldId | True | string |
ID vlastního pole |
|
Typ pole
|
fieldType | True | string |
Typ vlastního pole |
|
Název
|
name | True | string |
Název vlastního pole |
|
Hodnota
|
value | True | string |
Vlastní hodnota pole |
Návraty
Generování vložené podpisové adresy URL (V2)
Generování vložené podpisové adresy URL (V2)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Jedná se o podepisující osobu?
|
isInPersonSigner | True | string |
Yes/No |
|
Metoda ověřování
|
authenticationMethod | True | string |
Metoda ověřování |
|
Zpáteční adresa URL
|
returnUrl | True | string |
Zpáteční adresa URL |
|
Další přidaná adresa URL
|
additionalURL | True | dynamic |
Další přidaná adresa URL |
Návraty
Hromadné odeslání obálky pomocí šablony
Hromadné odeslání obálky pomocí šablony
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
Identifikátor GUID hromadného odeslání seznamu
|
bulkSendListId | True | string |
Identifikátor GUID hromadného odeslání seznamu |
|
ID šablony
|
envelopeOrTemplateId | True | string |
Zadejte ID šablony nebo zvolte šablonu z rozevíracího seznamu. |
Návraty
- Body
- BulkSendListGuid
Odebrání příjemce z obálky
Odebrání příjemce z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
Složka
|
folderId | True | string |
ID složky |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID příjemce
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
ID příjemce |
Návraty
Odeslat obálku
Odeslat existující obálku
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
Návraty
- response
- object
Použití šablony u dokumentů
Použití šablony u dokumentů
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID šablony
|
templateId | True | string |
Zadejte nebo vyberte ID šablony. |
|
Zachování příjemce šablony
|
preserve_template_recipient | string |
Nepravda |
|
|
ID dokumentu
|
documentId | True | string |
ID dokumentu |
|
Úvodní stránka dokumentu
|
documentStartPage | True | string |
Úvodní stránka dokumentu |
|
Koncová stránka dokumentu
|
documentEndPage | True | string |
Koncová stránka dokumentu |
Přidání dokumentů do obálky
Přidejte dokumenty do obálky.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Dokument Base64 *
|
documentBase64 | True | string |
Základní 64 obsah dokumentu |
|
Typ dokumentu *
|
fileExtension | True | string |
pdf, docx atd. |
|
Název dokumentu *
|
name | True | string |
název dokumentu |
|
Transformovat pole pdf
|
transformPdfFields | string |
Nepravda |
|
|
Přiřazení karet příjemcům
|
assignTabsToRecipientId | string |
ID příjemce |
Návraty
- Body
- AddDocumentsResponse
Přidání karet pro příjemce na obálku
Přidání karet pro příjemce na obálku
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID příjemce
|
recipientId | True | string |
Zadejte ID příjemce. |
|
Typ tabulátoru
|
tabType | True | string |
Typ tabulátoru |
|
podrobnosti o kartě
|
tabDetails | True | dynamic |
Podrobnosti o vybrané kartě ukotvení |
Návraty
Přidání připomenutí obálky
Přidání připomenutí obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Připomenutí povoleno
|
reminderEnabled | True | boolean |
Pokud je nastavená hodnota false, připomenutí jsou zakázaná. Výchozí hodnota je false |
|
Zpoždění připomenutí
|
reminderDelay | True | string |
Přidejte počet dní, po kterých příjemce obdrží e-mail s připomenutím. |
|
Frekvence připomenutí
|
reminderFrequency | True | string |
Přidejte počet dní mezi e-maily s připomenutím. |
|
Konec platnosti po
|
expireAfter | string |
Přidejte počet dní před vypršením platnosti. |
Návraty
- Body
- AddRemindersResponse
Přidání příjemce do obálky (V2)
Přidejte příjemce na obálku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Typ příjemce
|
recipientType | True | string |
Zadejte nebo vyberte typ příjemce. |
|
ID uživatele klienta
|
clientUserId | string |
ID uživatele klienta pro vložené podepisující osoby |
|
|
ID příjemce
|
recipientId | string |
Zadejte ID příjemce. |
|
|
Vložená počáteční adresa URL příjemce
|
embeddedRecipientStartURL | string |
Řetězec adresy URL poskytnuté odesílatelem pro přesměrování vloženého příjemce. |
|
|
Podpisová objednávka
|
routingOrder | string |
Podpisová objednávka příjemce. |
|
|
Jazyk e-mailových oznámení
|
emailNotificationLanguage | string |
Jazyk e-mailového oznámení |
|
|
Předmět e-mailového oznámení
|
emailNotificationSubject | string |
Předmět e-mailového oznámení |
|
|
Text e-mailového oznámení
|
emailNotificationBody | string |
Text e-mailového oznámení |
|
|
Poznámka:
|
note | string |
Vlastní poznámka pro příjemce |
|
|
Název role
|
roleName | string |
Název role přidružený k příjemci |
|
|
Směrové číslo země SMS
|
countryCode | string |
Pro sms oznámení, kód země bez úvodní + znaménko. |
|
|
Telefonní číslo SMS
|
phoneNumber | string |
Vyžaduje se e-mail podepisující osoby nebo telefon SMS. Vylučte kód země pro telefonní číslo. |
|
|
Podpisová skupina
|
signingGroupId | string |
Podpisová skupina |
|
|
Typ podpisu
|
signatureType | string |
Typy podpisů založených na standardech DocuSign (SBS). |
|
|
Pracovní postup ověření
|
workflowId | string |
Pracovní postupy IDV s typy podpisů pera musí být vybrány zde. |
|
|
podrobnosti o vybraném typu příjemce
|
additionalRecipientParams | dynamic |
Podrobnosti pro vybraný typ příjemce |
Návraty
- Body
- Signer
Přidání typu ověření k příjemci
Přidejte typ ověření k příjemci.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID příjemce
|
recipientId | True | string |
Zadejte ID příjemce. |
|
Typ příjemce
|
recipientType | True | string |
Zadejte nebo vyberte typ příjemce. |
|
Typ ověření
|
verificationType | True | string |
Typ ověření |
|
Další data příjemců
|
additionalRecipientData | dynamic |
Další údaje o příjemci. |
Přihlášení do systému
Spuštění pracovního postupu Docusign
Spuštění pracovního postupu Docusign
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
pracovní postup
|
workflowId | True | string |
Zadejte ID pracovního postupu nebo v rozevíracím seznamu vyberte název pracovního postupu. |
|
název instance
|
instanceName | True | string |
Název instance pracovního postupu |
|
proměnná
|
variable | dynamic |
Návraty
TriggerMaestroFlowResponse
- response
- object
Void the obálka
Vynulujte obálku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Důvod void
|
voidedReason | True | string |
Neplatný důvod |
Návraty
- response
- object
Vygenerovat vloženou adresu URL odesílatele
Vygenerovat vloženou adresu URL odesílatele
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Otevřít v aplikaci
|
openIn | True | string |
Otevřít v aplikaci |
|
Zpáteční adresa URL
|
returnUrl | True | string |
Zpáteční adresa URL |
|
Další přidaná adresa URL
|
additionalURL | dynamic |
Další přidaná adresa URL |
Návraty
Vygenerovat vloženou podpisovou adresu URL [ZASTARALÉ]
Generování vložené podpisové adresy URL
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Jméno podepisující osoby
|
signerName | True | string |
Jméno podepisující osoby |
|
E-mail podepisující osoby
|
signerEmail | True | string |
E-mail podepisující osoby |
|
ID uživatele klienta
|
clientUserId | string |
Vyžaduje se, pokud není uživatel přihlášený. Nechte prázdné pro podepisující osoby. |
|
|
Metoda ověřování
|
authenticationMethod | True | string |
Metoda ověřování |
|
Zpáteční adresa URL
|
returnUrl | True | string |
Zpáteční adresa URL |
|
Další přidaná adresa URL
|
additionalURL | dynamic |
Další přidaná adresa URL |
Návraty
Vytvoření obálky (V2)
Vytvořte novou prázdnou obálku.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
Email předmět
|
emailSubject | True | string |
Předmět e-mailu |
|
body
|
body | dynamic |
Text e-mailu a vlastní pole účtu |
Návraty
Vytvoření obálky pomocí složených šablon
Vytvoření obálky pomocí složených šablon
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
Email předmět
|
emailSubject | True | string |
Předmět e-mailu |
|
Text e-mailu
|
emailBody | string |
Text e-mailu |
|
|
Stav obálky
|
status | True | string |
Stav obálky |
|
Sloučení rolí a odstranění prázdných příjemců
|
merge_roles_on_draft | string |
Sloučení rolí a odstranění prázdných příjemců |
|
|
body
|
body | dynamic |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID obálky
|
envelopeId | string |
ID obálky. |
|
Stav
|
status | string |
Stav obálky. |
|
Datum a čas stavu
|
statusDateTime | string |
Datum a čas, kdy byl stav nastaven. |
|
identifikátor URI
|
uri | string |
Identifikátor URI obálky v DocuSignu. |
Vytvoření obálky pomocí šablony
Vytvořte novou obálku pomocí zadané šablony.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID šablony
|
templateId | True | string |
Zadejte nebo vyberte ID šablony. |
|
Stav obálky
|
status | True | string |
Stav obálky |
Návraty
Vytvoření obálky pomocí šablony s příjemci
Vytvořte novou obálku pomocí zadané šablony a zadejte příjemce.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
Stav obálky
|
status | True | string |
Stav obálky |
|
ID šablony
|
templateId | True | string |
Zadejte nebo vyberte ID šablony. |
|
Signatáři
|
signers | dynamic |
Podepisující osoby dokumentu. |
|
|
Email předmět
|
emailSubject | string |
Email předmět |
|
|
Text e-mailu
|
emailBody | string |
Text e-mailu |
Návraty
Vytvoření obálky pomocí šablony s příjemci a kartami
Vytvoření obálky pomocí šablony s příjemci a kartami
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID šablony
|
templateId | True | string |
Zadejte nebo vyberte ID šablony. |
|
Příjemci
|
recipients | dynamic |
Podepisující osoby dokumentu. |
|
|
Sloučení rolí a odstranění prázdných příjemců
|
merge_roles_on_draft | string |
Sloučení rolí a odstranění prázdných příjemců |
|
|
Email předmět
|
emailSubject | string |
Email předmět |
Návraty
Vytvoření seznamu hromadného odeslání
Vytvoření seznamu hromadného odeslání
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
Název hromadného odeslání seznamu
|
name | True | string |
Název hromadného odeslání seznamu |
|
Soubor CSV
|
csv | string |
Nahrání souboru CSV |
|
|
Pole generování dokumentů
|
rawOutput | object |
Pole generování dokumentů |
Návraty
- Body
- BulkSendListGuid
Výpis dokumentů z obálky
Výpis dokumentů z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
Návraty
Výpis dokumentů ze šablony
Výpis dokumentů ze šablony
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID šablony
|
templateId | True | string |
Zadejte nebo vyberte ID šablony. |
Návraty
Výpis obálek
Tato akce vrátí relevantní obálky Docusignu na základě stavu obálky, rozsahu kalendářních dat, jména příjemce, e-mailové adresy příjemce, názvu obálky, názvu dokumentu nebo hodnoty vlastního pole obálky. Výstupem je název, popis, ID obálky, názvy dokumentů, jména odesílatelů, stav obálky, datum odeslání a adresa URL obálky, která se dá použít jako odkaz k zobrazení obálky v Docusignu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
Jméno příjemce
|
recipientName | string |
Tato akce vypíše obálky na základě jména příjemce. |
|
|
E-mail příjemce
|
recipientEmailId | string |
Filtruje obálky podle e-mailu příjemce |
|
|
Předmět obálky
|
envelopeTitle | string |
Filtruje obálky podle předmětu obálky. |
|
|
Název vlastního pole
|
customFieldName | string |
Tato akce uvádí obálky na základě názvu vlastních polí. |
|
|
Vlastní hodnota pole
|
customFieldValue | string |
Filtry podle hodnoty vlastního pole |
|
|
Hledat slovo
|
search_text | string |
Zadáním jednoho klíčového slova najděte shody v předmětech obálky, příjemcůch a vlastních polích. |
|
|
Stav obálky
|
envelopeStatus | string |
Tato akce uvádí obálky na základě stavu obálky. |
|
|
Složka
|
folder_ids | string |
Filtruje obálky podle vybrané složky. |
|
|
Order by
|
order_by | string |
Seřadí obálky ve vybraném pořadí. |
|
|
Vrácení obálek
|
top | integer |
Zadejte počet obálek, které se mají vrátit (výchozí hodnota je 10, maximum je 1 000). |
|
|
Přeskočení obálek
|
skip | integer |
Zadejte počet obálek, které se mají přeskočit od začátku. |
|
|
Počáteční datum
|
from_date | date-time |
Zadejte počáteční datum a čas ve formátu UTC: 2017-05-02T01:44z |
|
|
Koncové datum
|
to_date | date-time |
Zadejte koncové datum a čas ve formátu UTC: 2017-05-02T01:44z. |
Návraty
Výpis příjemců z obálky
Výpis příjemců z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
Návraty
Výpis šablon
Vytvořte seznam šablon pro konkrétní účet.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
Návraty
ZASTARALÉ: Přidání příjemce do obálky (zastaralé) [ZASTARALÉ]
Přidání příjemce do obálky (zastaralé)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
ID účtu |
|
Obálka
|
envelopeId | True | string |
ID obálky |
|
Jméno podepisující osoby
|
AddRecipientToEnvelopeName | True | string |
Jméno příjemce. |
|
E-mail podepisující osoby
|
AddRecipientToEnvelopeEmail | True | string |
E-mail příjemce. |
|
Podpisová objednávka
|
routingOrder | string |
Podpisová objednávka příjemce v dokumentu. |
|
|
Role
|
roleName | string |
Role podepisující osoby. |
Návraty
ZASTARALÉ: Vytvoření obálky pomocí šablony (zastaralé) [ZASTARALÉ]
Vytvořte novou obálku pomocí zadané šablony (zastaralé).
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID šablony
|
templateId | True | string |
Zadejte nebo vyberte ID šablony. |
|
Stav obálky
|
status | True | string |
Stav obálky |
|
Vlastní pole
|
accountCustomFields | True | dynamic |
Získejte vlastní pole nastavená na úrovni účtu. |
Návraty
ZASTARALÉ: Získání dokumentů z obálky (zastaralé) [ZASTARALÉ]
Získání dokumentů z obálky (zastaralé)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
ID účtu |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Osvědčení o dokončení
|
certificate | True | boolean |
Pokud je nastavená hodnota false, podpisový certifikát obálky se odebere ze stahování. |
Návraty
- response
- GetDocumentsResponse
Znovu odeslat obálku
Tato akce znovu odešle obálku Docusignu nebo pošle připomenutí příjemcům, kteří potřebují podepsat smlouvu Docusign na základě zadaného ID obálky.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
Návraty
- response
- object
Zobrazit číslo sestavení (pouze pro referenci. Nezahrnujte do toku pro spuštění)
Identifikátor aktuálně nasazeného sestavení.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Číslo sestavení
|
buildNumber | dynamic |
Návraty
- response
- object
Získání dokumentů z obálky
Získání dokumentů z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Výstupní formát
|
documentId | True | string |
Zadáním řetězce (ID dokumentu) získáte jeden dokument nebo vyberete formát. |
|
Certifikát jazyka dokončování (volitelné)
|
language | string |
Výběr jazyka |
Návraty
- response
- GetDocumentsResponse
Získání informací o dokumentu z obálky
Získání informací o dokumentu z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Název dokumentu
|
documentName | True | string |
Název souboru s příponou |
Návraty
- Body
- EnvelopeDocument
Získání informací o příjemci z obálky
Získání informací o příjemci z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
E-mail příjemce
|
recipientEmail | string |
E-mail příjemce |
|
|
Směrové číslo
|
areaCode | string |
Směrové číslo oblasti příjemce |
|
|
Telefonní číslo
|
phoneNumber | string |
Telefonní číslo příjemce |
|
|
ID příjemce
|
recipientId | string |
Zadejte ID příjemce. |
Návraty
- Body
- Signer
Získání informací o vlastním poli obálky
Získejte informace o vlastním poli obálky.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
Název vlastního pole
|
fieldName | True | string |
Název vlastního pole |
Návraty
Získání informací pro kartu příjemce
Vrátí hodnotu karty daného příjemce.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID příjemce
|
recipientId | True | string |
Zadejte ID příjemce. |
|
Popisek tabulátoru
|
tabLabel | True | string |
Popisek tabulátoru |
Návraty
- Body
- Tab
Získání karet dokumentu z obálky
Získání karet dokumentu z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID dokumentu
|
documentId | True | string |
Zadejte ID dokumentu. |
Návraty
- Body
- ListTabsResponse
Získání karet dokumentů ze šablony
Získání karet dokumentů ze šablony
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID šablony
|
templateId | True | string |
Zadejte nebo vyberte ID šablony. |
|
ID dokumentu
|
documentId | True | string |
Zadejte ID dokumentu. |
Návraty
- Body
- ListTabsResponse
Získání karet příjemců z obálky
Získání karet příjemců z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID příjemce
|
recipientId | True | string |
Zadejte ID příjemce. |
Návraty
Získání polí formuláře generování dokumentu z obálky
Získání polí formuláře generování dokumentu z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
Návraty
Získání polí formuláře generování dokumentů ze šablony (pouze šablony hromadného odesílání)
Získání polí formuláře generování dokumentů ze šablony (pouze šablony hromadného odesílání)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID šablony
|
templateId | True | string |
Zadejte nebo vyberte ID šablony. |
Návraty
Pole formuláře generování dokumentů ze šablony
- Pole šablony DocGen
- object
Získání seznamu událostí auditu
Získání seznamu událostí auditu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
Návraty
- response
- object
Získání vlastních polí dokumentu z obálky
Získání vlastních polí dokumentu z obálky
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte nebo vyberte ID účtu. |
|
ID obálky
|
envelopeId | True | string |
Zadejte ID obálky. |
|
ID dokumentu
|
documentId | True | string |
Zadejte ID dokumentu. |
Návraty
Aktivační události
| Když dojde k události Docusign Connect (úroveň organizace) |
Aktivuje nový tok, když se změní stav obálky. |
| Když dojde k události Docusign Connect (úroveň účtu) |
Aktivuje nový tok, když se změní stav obálky. |
| ZASTARALÉ: Když se změní stav obálky (Připojení) (V2) (zastaralé) [ZASTARALÉ] |
Aktivuje nový tok, když se změní stav obálky (zastaralé). |
| ZASTARALÉ: Když se změní stav obálky (Připojení) (zastaralé) [ZASTARALÉ] |
Aktivuje nový tok, když se změní stav obálky (zastaralé). |
Když dojde k události Docusign Connect (úroveň organizace)
Aktivuje nový tok, když se změní stav obálky.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID organizace
|
organizationId | True | string |
Zadejte nebo vyberte ID organizace. |
|
Název konfigurace připojení
|
name | True | string |
Pojmenujte konfiguraci připojení (například Události obálky). |
|
Aktivační události
|
events | True | array of string |
Vyberte událost. Pokud chcete zahrnout jinou událost, vyberte Přidat novou položku. |
Návraty
Když dojde k události Docusign Connect (úroveň účtu)
Aktivuje nový tok, když se změní stav obálky.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID účtu
|
accountId | True | string |
Zadejte ID účtu nebo vyberte účet z rozevíracího seznamu. |
|
Název konfigurace připojení
|
name | True | string |
Pojmenujte konfiguraci připojení (například Události obálky). |
|
Aktivační události
|
events | True | array of string |
Vyberte událost. Pokud chcete zahrnout jinou událost, vyberte Přidat novou položku. |
Návraty
ZASTARALÉ: Když se změní stav obálky (Připojení) (V2) (zastaralé) [ZASTARALÉ]
Aktivuje nový tok, když se změní stav obálky (zastaralé).
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
ID účtu |
|
Název připojení
|
name | True | string | |
|
Událost obálky
|
envelopeEvents | True | string |
Návraty
ZASTARALÉ: Když se změní stav obálky (Připojení) (zastaralé) [ZASTARALÉ]
Aktivuje nový tok, když se změní stav obálky (zastaralé).
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
ID účtu |
|
Název připojení
|
name | True | string | |
|
Událost obálky
|
envelopeEvents | True | string |
Návraty
Definice
WebhookEnvelopeResponseV2
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Vlastní pole obálky
|
data.envelopeSummary.customFields | object |
Páry klíč-hodnota představující vlastní pole pro tuto obálku (kde klíč je název pole a hodnota je hodnota pole). |
|
Obálka vytvořená Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
ID obálky
|
data.envelopeSummary.envelopeId | string | |
|
Odeslaná obálka Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Stav obálky
|
data.envelopeSummary.status | string | |
|
Předmět e-mailu
|
data.envelopeSummary.emailSubject | string | |
|
envelopeDocuments
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
ID dokumentu
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Identifikátor GUID dokumentu
|
data.envelopeSummary.envelopeDocuments.documentGuid | string | |
|
Název dokumentu
|
data.envelopeSummary.envelopeDocuments.documentName | string | |
|
Jméno odesílatele
|
data.envelopeSummary.sender.userName | string | |
|
ID uživatele odesílatele
|
data.envelopeSummary.sender.userId | string | |
|
ID účtu odesílatele
|
data.envelopeSummary.sender.accountId | string | |
|
E-mailová adresa odesílatele
|
data.envelopeSummary.sender.email | string | |
|
Signatáři
|
data.envelopeSummary.recipients.signers | array of object | |
|
Tabulátory
|
data.envelopeSummary.recipients.signers.tabs | object |
Páry klíč-hodnota představující karty tohoto příjemce (kde klíč je název pole a hodnota je hodnota pole). |
|
E-mail příjemce
|
data.envelopeSummary.recipients.signers.email | string | |
|
ID příjemce
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Pořadí směrování
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Příjemce odeslaný Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Stav příjemce
|
data.envelopeSummary.recipients.signers.status | string |
Stav příjemce. |
|
Typ příjemce
|
data.envelopeSummary.recipients.signers.recipientType | string |
Typ příjemce. |
|
Typ ověření
|
data.envelopeSummary.recipients.signers.verificationType | string |
Typ ověření. |
|
Jméno příjemce
|
data.envelopeSummary.recipients.signers.name | string |
Jméno příjemce. |
WebhookOrganizationResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID organizace
|
data.organizationId | string |
ID organizace. |
|
Vlastní pole obálky
|
data.envelopeSummary.customFields | object |
Páry klíč-hodnota představující vlastní pole pro tuto obálku (kde klíč je název pole a hodnota je hodnota pole). |
|
Obálka vytvořená Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
ID obálky
|
data.envelopeSummary.envelopeId | string | |
|
Odeslaná obálka Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Stav obálky
|
data.envelopeSummary.status | string | |
|
Předmět e-mailu
|
data.envelopeSummary.emailSubject | string | |
|
envelopeDocuments
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
ID dokumentu
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Identifikátor GUID dokumentu
|
data.envelopeSummary.envelopeDocuments.documentGuid | string | |
|
Název dokumentu
|
data.envelopeSummary.envelopeDocuments.documentName | string | |
|
Jméno odesílatele
|
data.envelopeSummary.sender.userName | string | |
|
ID uživatele odesílatele
|
data.envelopeSummary.sender.userId | string | |
|
ID účtu odesílatele
|
data.envelopeSummary.sender.accountId | string | |
|
E-mailová adresa odesílatele
|
data.envelopeSummary.sender.email | string | |
|
Signatáři
|
data.envelopeSummary.recipients.signers | array of object | |
|
Tabulátory
|
data.envelopeSummary.recipients.signers.tabs | object |
Páry klíč-hodnota představující karty tohoto příjemce (kde klíč je název pole a hodnota je hodnota pole). |
|
E-mail příjemce
|
data.envelopeSummary.recipients.signers.email | string | |
|
ID příjemce
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Pořadí směrování
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Příjemce odeslaný Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Stav příjemce
|
data.envelopeSummary.recipients.signers.status | string |
Stav příjemce. |
|
Typ příjemce
|
data.envelopeSummary.recipients.signers.recipientType | string |
Typ příjemce. |
|
Typ ověření
|
data.envelopeSummary.recipients.signers.verificationType | string |
Typ ověření. |
|
Jméno příjemce
|
data.envelopeSummary.recipients.signers.name | string |
Jméno příjemce. |
WebhookEnvelopeResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Vlastní pole obálky
|
customFields | object |
Páry klíč-hodnota představující vlastní pole pro tuto obálku (kde klíč je název pole a hodnota je hodnota pole). |
|
Obálka vytvořená Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
E-mailová adresa odesílatele
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
ID obálky
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
IP adresa odesílatele
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
Odeslaná obálka Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Stav obálky
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
Předmět
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
Jméno odesílatele
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
RecipientStatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
Tabulátory
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
Páry klíč-hodnota představující karty tohoto příjemce (kde klíč je název pole a hodnota je hodnota pole). |
|
Důvod odmítnutí
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
E-mail příjemce
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
ID příjemce
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
Pořadí směrování
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
Příjemce odeslaný Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
yyyy-MM-ddTHH:mm:ss.fffZ |
|
Stav příjemce
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
Stav příjemce. |
|
Typ příjemce
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
Typ příjemce. |
|
Jméno příjemce
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
Jméno příjemce. |
|
Časová zóna
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
Posun časového pásma
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocumentsResponse
- Obsah souboru
- binary
AddRemindersResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Připomenutí povoleno
|
reminderEnabled | string |
Připomenutí povoleno |
FilteredEnvelopes
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Title
|
title | string |
Název obálky |
|
Description
|
description | string |
Popis aktivity obálky |
|
ID obálky
|
envelopeId | string |
ID obálky |
|
Documents
|
documents | string |
Seznam názvů dokumentů |
|
Jména příjemců
|
recipients | string |
Seznam jmen příjemců |
|
Jméno odesílatele
|
sender | string |
Jméno odesílatele |
|
Stav
|
status | string |
Stav obálky |
|
Datum stavu
|
statusDate | string |
Poslední aktualizace stavu aktivity |
|
Datum odeslání
|
dateSent | date-time |
Datum odeslání obálky |
|
URL
|
url | string |
Adresa URL obálky |
EmbeddedSenderResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Vložená adresa URL odesílatele
|
url | string |
Adresa URL vloženého zobrazení odesílatele. |
EmbeddedSigningResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
URL
|
url | string |
Adresa URL vloženého zobrazení podepisování. |
FilteredEnvelopeListResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Filtrované obálky
|
value | array of FilteredEnvelopes |
Filtrované obálky |
|
Další výsledky obálek
|
hasMoreResults | boolean |
Zobrazuje, jestli obálky překročí zadané číslo v poli Zpáteční obálky. |
CreateEnvelopeResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID obálky
|
envelopeId | string |
ID obálky. |
|
ID šablony
|
templateId | string |
ID šablony. |
|
Stav
|
status | string |
Stav obálky. |
|
Datum a čas stavu
|
statusDateTime | string |
Datum a čas, kdy byl stav nastaven. |
|
identifikátor URI
|
uri | string |
Identifikátor URI obálky v DocuSignu. |
ListRecipientsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID obálky
|
envelopeId | string | |
|
Signatáři
|
signers | array of Signer |
Signatáři |
Tab
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název karty
|
name | string |
Název karty |
|
Typ karty
|
tabType | string |
Typ karty. |
|
Popisek karty
|
tabLabel | string |
Popisek karty |
|
Hodnota karty
|
value | string |
Hodnota karty. |
|
ID karty
|
tabId | string |
ID karty. |
|
ID dokumentu
|
documentId | string |
ID dokumentu. |
|
ID příjemce
|
recipientId | string |
ID příjemce. |
|
Je předvyplnění
|
prefill | boolean |
Určuje, jestli je karta typu předběžného vyplňování. |
|
Vybraný
|
selected | string |
Pokud je zaškrtávací políčko tabulátory, označuje, jestli je tato karta vybraná. |
RecipientTabsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Karta Příjemce:
|
recipientTabs | array of Tab |
Karta Příjemce |
Signatář
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Podpisová objednávka
|
routingOrder | string |
Podpisová objednávka příjemce v dokumentu. |
|
Role
|
roleName | string |
Role podepisující osoby. |
|
ID příjemce
|
recipientId | string |
ID příjemce. |
|
Název
|
name | string |
Jméno příjemce. |
|
Email
|
string |
E-mail příjemce. |
|
|
Typ příjemce
|
recipientType | string |
Zadejte příjemce. |
|
Typ ověření
|
verificationType | string |
Typ ověření. |
|
IDENTIFIKÁTOR GUID příjemce
|
recipientIdGuid | string |
Identifikátor GUID příjemce. |
GetLoginAccountsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Přihlašovací účty
|
loginAccounts | array of LoginAccount |
Přihlašovací účty |
LoginAccount
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název
|
name | string |
Název účtu. |
|
Identifikátor GUID ID účtu
|
accountIdGuid | string |
Identifikátor GUID účtu. |
ListTabsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Tabulátory
|
tabs | array of Tab |
Tabulátory |
ListEnvelopeDocumentFieldsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Vlastní pole
|
envelopeDocumentFields | array of EnvelopeDocumentField |
Vlastní pole dokumentu |
DocGenFormFieldsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Pole Docgen
|
docgenFields | array of DocGenFormField |
Pole Docgen |
DocGenFormField
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID dokumentu
|
documentId | string |
ID dokumentu. |
|
Označení
|
label | string |
Označit. |
|
Typ
|
type | string |
Typ: |
|
Název
|
name | string |
Název. |
|
Hodnota
|
value | string |
Hodnota. |
ListTemplatesResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Šablony obálek
|
envelopeTemplates | array of EnvelopeTemplate |
Dostupné šablony obálek. |
ObálkaTemplate
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID šablony
|
templateId | string |
ID šablony. |
|
Název
|
name | string |
Název šablony. |
BulkSendListGuid
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Identifikátor GUID hromadného odeslání seznamu
|
listId | string |
Identifikátor GUID hromadného odeslání seznamu |
ObálkaCustomFieldResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID pole
|
fieldId | string |
ID vlastního pole obálky. |
|
Typ pole
|
fieldType | string |
Typ vlastního pole obálky. |
|
Název
|
name | string |
Název vlastního pole obálky |
|
Hodnota
|
value | string |
Hodnota vlastního pole obálky. |
UpdateEnvelopeCustomFieldResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID pole
|
fieldId | string |
ID vlastního pole obálky. |
|
Typ pole
|
fieldType | string |
Typ vlastního pole obálky. |
|
Název
|
name | string |
Název vlastního pole obálky |
|
Hodnota
|
value | string |
Hodnota vlastního pole obálky. |
ListDocumentsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Obálkové dokumenty
|
envelopeDocuments | array of EnvelopeDocument |
Dokumenty připojené k obálce. |
ListTemplateDocumentsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Dokumenty šablon
|
templateDocuments | array of EnvelopeDocument |
Dokumenty připojené k šabloně |
AddDocumentsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID obálky
|
envelopeId | string |
ID obálky. |
|
Obálkové dokumenty
|
envelopeDocuments | array of EnvelopeDocument |
Dokumenty připojené k obálce. |
AddRecipientTabsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Karty příjemce
|
recipientTabs | array of RecipientTab |
Karty přidané k příjemci. |
EnvelopeDocument
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název
|
name | string |
Název dokumentu. |
|
ID dokumentu
|
documentId | string |
ID dokumentu. |
|
Identifikátor GUID dokumentu
|
documentIdGuid | string |
Identifikátor GUID dokumentu. |
RecipientTab
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
ID karty
|
tabId | string |
ID karty. |
|
Typ karty
|
tabType | string |
Typ karty. |
EnvelopeDocumentField
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Název
|
name | string |
Název vlastního pole |
|
Hodnota
|
value | string |
Hodnota vlastního pole. |
DeclineReasonWithoutType
objekt
Toto je typ "object".