Sdílet prostřednictvím

Docusign

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.

Tento konektor je dostupný v následujících produktech a oblastech:

Service Class Regions
Copilot Studio Standard Všechny oblasti Power Automate s výjimkou následujících:
     - China Cloud provozovaný společností 21Vianet
Logic Apps Standard Všechny oblasti Logic Apps s výjimkou následujících:
     – Oblasti Azure China
     - Ministerstvo obrany USA (DoD)
Power Apps Standard Všechny oblasti Power Apps s výjimkou následujících:
     - China Cloud provozovaný společností 21Vianet
Power Automate Standard Všechny oblasti Power Automate s výjimkou následujících:
     - China Cloud provozovaný společností 21Vianet
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:

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 nejsou 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í

Pomocí těchto pokynů nasaďte tento konektor jako vlastní konektor v Microsoft Power Automate a Power Apps.

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
Copilot for Sales: List envelopes

Copilot for Sales: Obálky seznamu vrátí informace o smlouvách Docusign, jako je název, dokumenty, příjemci, stav smlouvy, jméno odesílatele a adresa URL smlouvy. Modul plug-in může zpracovávat žádosti, jako je zobrazení všech mých smluv, které potřebuji podepsat nebo jaký je stav smlouvy o prodejní objednávce.
Copilot for Sales: Získání klíčového prodeje

Tato akce získá další přehledy o prodeji, které se zobrazí na kartě s klíčovými prodejními informacemi C4S v postranním panelu Outlooku. Akce vylepšuje stávající dovednosti copilotu pro prodej.
Copilot for Sales: Získání souhrnu e-mailu

Tato akce získá dodatečně přehledy prodeje, které se zobrazí v prostředí e-mailového souhrnu C4S v rámci souhrnu Outlooku. Akce vylepšuje stávající dovednosti kopilota v oblasti prodeje.
Copilot: 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.
Copilot: Získání souvisejících aktivit

Tato akce získá další přehledy prodeje související se záznamem CRM, které se zobrazí na kartě souhrnu záznamů C4S. Akce vylepšuje stávající dovednosti kopilota v oblasti prodeje.
Copilot: Získání souvisejících záznamů

Tato akce získá záznamy související se záznamem CRM. Akce vylepšuje stávající dovednosti funkce Copilot for Sales.
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
Seznam příjemců z obálky

Seznam příjemců z obálky
Spuštění pracovního postupu Docusign Mae

Spuštění pracovního postupu Docusign Mae
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

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 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 šablon

Vytvořte seznam šablon pro konkrétní účet.
ZASTARALÉ: Přidání příjemce do obálky

Přidejte příjemce na obálku.
ZASTARALÉ: Vytvoření obálky pomocí šablony

Vytvořte novou obálku pomocí zadané šablony.
ZASTARALÉ: Vytvoření obálky pomocí šablony s příjemci

Vytvořte novou obálku pomocí zadané šablony a zadejte příjemce.
ZASTARALÉ: Získání dokumentů z obálky

Získání dokumentů z obálky
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ích polích z obálky

Získání informací o vlastních polích z 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í 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

ID operace:
UpdateRecipientTabsValues

Aktualizace hodnot karet příjemců na obálce

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
Recipient
 recipientId True string

ID příjemce
Typ
 tabType string

Typ tabulátoru
identifikační číslo
 tabId string

identifikační číslo
Hodnota
 value string

Hodnota

Aktualizace karet předvyplnění obálek

ID operace:
UpdateEnvelopePrefillTabs

Aktualizace hodnot pro seznam karet předvyplnění

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
ID dokumentu
 documentId True string

ID dokumentu
Typ
 tabType string

Typ
identifikační číslo
 tabId string

identifikační číslo
Hodnota
 value string

Hodnota

Aktualizace polí formuláře generování dokumentů z obálky

ID operace:
UpdateDocgenFormFields

Aktualizace polí formuláře generování dokumentů z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

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.
: 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

ID operace:
UpdateEnvelopeRecipient

Aktualizace příjemce na obálce

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
ID příjemce
 recipientId True string

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 integer

Pro sms oznámení, kód země bez úvodní + znaménko.
Telefonní číslo SMS
 phoneNumber integer

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

ID operace:
UpdateEnvelopeCustomField

Aktualizace hodnoty pro zadané vlastní pole obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

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

Body
UpdateEnvelopeCustomFieldResponse

Copilot for Sales: List envelopes

ID operace:
SalesCopilotListEnvelopes

Copilot for Sales: Obálky seznamu vrátí informace o smlouvách Docusign, jako je název, dokumenty, příjemci, stav smlouvy, jméno odesílatele a adresa URL smlouvy. Modul plug-in může zpracovávat žádosti, jako je zobrazení všech mých smluv, které potřebuji podepsat nebo jaký je stav smlouvy o prodejní objednávce.

Parametry

Name Klíč Vyžadováno Typ Description
Jméno příjemce
 recipientName string

Tato akce vypíše obálky na základě jména příjemce.
Id e-mailu příjemce
 recipientEmailId string

Tato akce uvádí obálky na základě ID e-mailu příjemce.
Předmět obálky
 envelopeTitle string

Tato akce uvádí obálky na základě předmětu e-mailu 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

Tato akce vypíše obálky na základě hodnoty vlastních polí.
Stav obálky
 envelopeStatus string

Tato akce uvádí obálky na základě stavu obálky.
Složka
 folder_ids string

Tato akce uvádí obálky na základě různých stavů obálky.
Order by
 order_by string

Tato akce objedná obálky na základě konkrétní vlastnosti.
Vrchol
 top integer

Horní obálky, které se mají vrátit
Přeskočit
 skip integer

Obálky, které se mají přeskočit
Počáteční datum
 startDateTime date-time

Zadejte počáteční datum a čas ve formátu: 2017-05-02T01:44Z
Koncové datum
 endDateTime date-time

Zadejte koncové datum a čas ve formátu: 2017-05-02T01:44Z

Návraty

Body
FilteredSalesCopilotEnvelopeListResponse

Copilot for Sales: Získání klíčového prodeje

ID operace:
scp-get-key-sales

Tato akce získá další přehledy o prodeji, které se zobrazí na kartě s klíčovými prodejními informacemi C4S v postranním panelu Outlooku. Akce vylepšuje stávající dovednosti copilotu pro prodej.

Parametry

Name Klíč Vyžadováno Typ Description
Typ záznamu
 recordType True string

Tento vstup identifikuje typ záznamu v CRM, pro který jsou požadovány klíčové údaje o prodeji.
ID záznamu
 recordId True string

Tento vstup poskytuje jedinečný identifikátor záznamu CRM, pro který jsou požadovány klíčové údaje o prodeji.
Počáteční datum
 startDateTime date-time

Zadejte počáteční datum a čas ve formátu: 2017-05-02T01:44Z
Vrchol
 top integer

Tento vstup označuje počet prodejních vrcholů, které je potřeba načíst.
Přeskočit
 skip integer

Tento vstup označuje počet položek, které se mají přeskočit při načítání hlavních prodejních bodů.
Typ CRM
 crmType string

Tento vstup označuje typ CRM, ve kterém existuje záznam CRM, pro který jsou požadovány klíčové údaje o prodeji.
Adresa URL organizace CRM
 crmOrgUrl string

Tento vstup označuje adresu URL prostředí CRM, ve kterém existuje záznam CRM, pro který jsou požadovány klíčové údaje o prodeji.

Návraty

Body
KeySalesResponse

Copilot for Sales: Získání souhrnu e-mailu

ID operace:
scp-get-email-summary

Tato akce získá dodatečně přehledy prodeje, které se zobrazí v prostředí e-mailového souhrnu C4S v rámci souhrnu Outlooku. Akce vylepšuje stávající dovednosti kopilota v oblasti prodeje.

Parametry

Name Klíč Vyžadováno Typ Description
Typ záznamu
 recordType string

Tento vstup identifikuje typ záznamu v CRM, který souvisí s souhrnným e-mailem.
ID záznamu
 recordId string

Tento vstup poskytuje jedinečný identifikátor záznamu CRM, který souvisí s souhrnným e-mailem.
Typ CRM
 crmType string

Tento vstup označuje typ CRM, ve kterém záznam související se souhrnným e-mailem existuje.
Adresa URL organizace CRM
 crmOrgUrl string

Tento vstup označuje adresu URL prostředí CRM, ve kterém existuje záznam související s souhrnným e-mailem.
E-mailové adresy oddělené čárkami
 emailContacts True string

Tento vstup označuje seznam všech relevantních e-mailů účastníků v aktuálním e-mailovém vlákně.
Vrchol
 top integer

Tento vstup udává počet přehledů k načtení.
Přeskočit
 skip integer

Tento vstup označuje počet položek, které se mají přeskočit při načítání přehledů.

Návraty

Body
EmailSummaryResponse

Copilot: Výpis obálek

ID operace:
ListEnvelopes

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
Jméno příjemce
 recipientName string

Tato akce vypíše obálky na základě jména příjemce.
Id e-mailu příjemce
 recipientEmailId string

Tato akce uvádí obálky na základě ID e-mailu příjemce.
Předmět obálky
 envelopeTitle string

Tato akce uvádí obálky na základě předmětu e-mailu 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

Tato akce vypíše obálky na základě hodnoty vlastních polí.
Stav obálky
 envelopeStatus string

Tato akce uvádí obálky na základě stavu obálky.
Složka
 folder_ids string

Tato akce uvádí obálky na základě různých stavů obálky.
Order by
 order_by string

Tato akce objedná obálky na základě konkrétní vlastnosti.
Vrchol
 top integer

Horní obálky, které se mají vrátit
Přeskočit
 skip integer

Obálky, které se mají přeskočit
Počáteční datum
 from_date date-time

Pokud uživatel nezadá žádnou hodnotu, zadejte ''. Zadejte počáteční datum a čas ve vzoru nebo formátu: 2017-05-02T01:44Z.
Koncové datum
 to_date date-time

Pokud uživatel nezadá žádnou hodnotu, zadejte ''. Zadejte koncové datum a čas ve vzoru nebo formátu: 2017-05-02T01:44Z.

Návraty

Body
FilteredEnvelopeListResponse

Copilot: Získání souvisejících aktivit

ID operace:
scp-get-related-activities

Tato akce získá další přehledy prodeje související se záznamem CRM, které se zobrazí na kartě souhrnu záznamů C4S. Akce vylepšuje stávající dovednosti kopilota v oblasti prodeje.

Parametry

Name Klíč Vyžadováno Typ Description
Typ záznamu
 recordType True string

Tento vstup označuje entitu nebo objekt v CRM, pro který jsou požadovány přehledy.
ID záznamu
 recordId True string

Tento vstup označuje jedinečný identifikátor záznamu v CRM, pro který jsou požadovány přehledy.
Počáteční datum
 startDateTime date-time

Tento vstup označuje datum a čas zahájení požadovaných přehledů.
Koncové datum
 endDateTime date-time

Tento vstup označuje datum a čas ukončení požadovaných přehledů.
Vrchol
 top integer

Tento vstup udává počet přehledů k načtení.
Přeskočit
 skip integer

Tento vstup udává počet přehledů k přeskočení.
Typ CRM
 crmType string

Tento vstup označuje typ CRM, ve kterém existuje záznam CRM, pro který jsou požadovány přehledy.
Adresa URL organizace CRM
 crmOrgUrl string

Tento vstup označuje adresu URL prostředí CRM, ve kterém existuje záznam CRM, pro který jsou požadovány přehledy.

Návraty

Body
ActivityListResponseEnvelope

Copilot: Získání souvisejících záznamů

ID operace:
scp-get-related-records

Tato akce získá záznamy související se záznamem CRM. Akce vylepšuje stávající dovednosti funkce Copilot for Sales.

Parametry

Name Klíč Vyžadováno Typ Description
Typ záznamu
 recordType True string

Tento vstup identifikuje typ záznamu v CRM, pro který se požadují související záznamy.
ID záznamu
 recordId True string

Tento vstup poskytuje jedinečný identifikátor záznamu CRM, pro který jsou požadovány související záznamy.
Počáteční datum
 startDateTime date-time

Zadejte počáteční datum a čas ve formátu: 2017-05-02T01:44Z
Vrchol
 top integer

Tento vstup označuje počet souvisejících záznamů, které se mají načíst.
Přeskočit
 skip integer

Tento vstup označuje počet záznamů, které se mají přeskočit při načítání souvisejících záznamů.
Typ CRM
 crmType string

Tento vstup označuje typ CRM, ze které se načítají související záznamy.
Adresa URL organizace CRM
 crmOrgUrl string

Tento vstup označuje adresu URL prostředí CRM, ze které se načítají související záznamy.

Návraty

Body
DocumentRecordListResponseEnvelope

Generování vložené podpisové adresy URL (V2)

ID operace:
GenerateEmbeddedSigningURLV2

Generování vložené podpisové adresy URL (V2)

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

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

Body
EmbeddedSigningResponse

Hromadné odeslání obálky pomocí šablony

ID operace:
BulkSend

Hromadné odeslání obálky pomocí šablony

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

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

ID operace:
RemoveRecipientFromEnvelope

Odebrání příjemce z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Složka
 folderId True string

ID složky
Obálka
 envelopeId True string

ID obálky
Recipient
 RemoveRecipientFromEnvelopeRecipientId True string

ID příjemce

Návraty

Body
ListRecipientsResponse

Odeslat obálku

ID operace:
SendDraftEnvelope

Odeslat existující obálku

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky

Návraty

response
object

Použití šablony u dokumentů

ID operace:
ApplyTemplatesToDocuments

Použití šablony u dokumentů

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
ID obálky
 envelopeId True string

ID obálky
Template
 templateId True string

Template
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

ID operace:
AddDocumentsToEnvelope

Přidejte dokumenty do obálky.

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

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

ID operace:
AddRecipientTabs

Přidání karet pro příjemce na obálku

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
Recipient
 recipientId True string

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

Body
AddRecipientTabsResponse

Přidání připomenutí obálky

ID operace:
AddReminders

Přidání připomenutí obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

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)

ID operace:
AddRecipientToEnvelopeV2

Přidejte příjemce na obálku.

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
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 integer

Pro sms oznámení, kód země bez úvodní + znaménko.
Telefonní číslo SMS
 phoneNumber integer

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

ID operace:
AddVerificationToRecipient

Přidejte typ ověření k příjemci.

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
ID příjemce
 recipientId True string

ID příjemce
Typ příjemce
 recipientType True string

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

ID operace:
GetLoginAccounts

Přihlášení do systému

Návraty

Body
GetLoginAccountsResponse

Seznam příjemců z obálky

ID operace:
GetRecipientStatus

Seznam příjemců z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Složka
 folderId True string

ID složky
Obálka
 envelopeId True string

ID obálky

Návraty

Body
ListRecipientsResponse

Spuštění pracovního postupu Docusign Mae

ID operace:
TriggerMaestroFlow

Spuštění pracovního postupu Docusign Mae

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

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 Mae
proměnná
 variable dynamic

Návraty

TriggerMaestroFlowResponse

response
object

Void the obálka

ID operace:
VoidEnvelope

Vynulujte obálku.

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
Důvod void
 voidedReason True string

Neplatný důvod

Návraty

response
object

Vygenerovat vloženou adresu URL odesílatele

ID operace:
GenerateEmbeddedSenderURL

Vygenerovat vloženou adresu URL odesílatele

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

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

Body
EmbeddedSenderResponse

Vygenerovat vloženou podpisovou adresu URL [ZASTARALÉ]

ID operace:
GenerateEmbeddedSigningURL

Generování vložené podpisové adresy URL

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
 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

Body
EmbeddedSigningResponse

Vytvoření obálky

ID operace:
CreateBlankEnvelope

Vytvořte novou prázdnou obálku.

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Email předmět
 emailSubject True string

Předmět e-mailu
Text e-mailu
 emailBody string

Text e-mailu
Vlastní pole
 accountCustomFields dynamic

Získejte vlastní pole nastavená na úrovni účtu.

Návraty

Body
CreateEnvelopeResponse

Vytvoření obálky pomocí složených šablon

ID operace:
CompositeTemplates

Vytvoření obálky pomocí složených šablon

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

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
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

ID operace:
CreateEnvelopeFromTemplateNoRecipients

Vytvořte novou obálku pomocí zadané šablony.

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Template
 templateId True string

ID šablony
Stav obálky
 status True string

Stav obálky

Návraty

Body
CreateEnvelopeResponse

Vytvoření obálky pomocí šablony s příjemci a kartami

ID operace:
SendEnvelopeWithRecipientFields

Vytvoření obálky pomocí šablony s příjemci a kartami

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Template
 templateId True string

ID šablony
Příjemci
 recipients dynamic

Podepisující osoby dokumentu.
Email předmět
 emailSubject string

Email předmět

Návraty

Body
CreateEnvelopeResponse

Vytvoření seznamu hromadného odeslání

ID operace:
CreateBulkSendList

Vytvoření seznamu hromadného odeslání

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

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

Návraty

Body
BulkSendListGuid

Výpis dokumentů z obálky

ID operace:
ListEnvelopeDocuments

Výpis dokumentů z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky

Návraty

Body
ListDocumentsResponse

Výpis dokumentů ze šablony

ID operace:
ListTemplateDocuments

Výpis dokumentů ze šablony

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Template
 templateId True string

ID šablony

Návraty

Body
ListTemplateDocumentsResponse

Výpis obálek

ID operace:
SearchListEnvelopes

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
Account
 accountId True string

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
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

Body
FilteredEnvelopeListResponse

Výpis šablon

ID operace:
GetEnvelopeTemplates

Vytvořte seznam šablon pro konkrétní účet.

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu

Návraty

Body
ListTemplatesResponse

ZASTARALÉ: Přidání příjemce do obálky

ID operace:
AddRecipientToEnvelope

Přidejte příjemce na obálku.

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

Body
ListRecipientsResponse

ZASTARALÉ: Vytvoření obálky pomocí šablony

ID operace:
CreateEnvelopeFromTemplate

Vytvořte novou obálku pomocí zadané šablony.

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Template
 templateId True string

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

Body
CreateEnvelopeResponse

ZASTARALÉ: Vytvoření obálky pomocí šablony s příjemci

ID operace:
SendEnvelope

Vytvořte novou obálku pomocí zadané šablony a zadejte příjemce.

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Stav obálky
 status True string

Stav obálky
Template
 templateId True string

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

Body
CreateEnvelopeResponse

ZASTARALÉ: Získání dokumentů z obálky

ID operace:
GetDocuments

Získání dokumentů z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

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

ID operace:
ResendEnvelope

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
Obálka
 envelopeId True string

ID obálky

Návraty

response
object

Zobrazit číslo sestavení (pouze pro referenci. Nezahrnujte do toku pro spuštění)

ID operace:
BuildNumber

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

ID operace:
GetDocumentsV2

Získání dokumentů z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
Výstupní formát
 documentId True string

Zadejte konkrétní ID dokumentu nebo použijte výstupní formát z rozevíracího seznamu.

Návraty

response
GetDocumentsResponse

Získání informací o dokumentu z obálky

ID operace:
GetEnvelopeDocumentInfo

Získání informací o dokumentu z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

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

ID operace:
GetRecipientFields

Získání informací o příjemci z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

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

ID recipinetu

Návraty

Body
Signer

Získání informací o vlastních polích z obálky

ID operace:
GetEnvelopeCustomField

Získání informací o vlastních polích z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
Název vlastního pole
 fieldName True string

Název vlastního pole

Návraty

Body
EnvelopeCustomFieldResponse

Získání informací pro kartu příjemce

ID operace:
GetTabInfo

Vrátí hodnotu karty daného příjemce.

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
ID příjemce
 recipientId True string

ID příjemce
Popisek tabulátoru
 tabLabel True string

Popisek tabulátoru

Návraty

Body
Tab

Získání karet dokumentu z obálky

ID operace:
GetEnvelopeDocumentTabs

Získání karet dokumentu z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
ID dokumentu
 documentId True string

ID dokumentu

Návraty

Body
ListTabsResponse

Získání karet dokumentů ze šablony

ID operace:
GetTemplateDocumentTabs

Získání karet dokumentů ze šablony

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Template
 templateId True string

ID šablony
ID dokumentu
 documentId True string

ID dokumentu

Návraty

Body
ListTabsResponse

Získání karet příjemců z obálky

ID operace:
GetEnvelopeRecipientTabs

Získání karet příjemců z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
ID příjemce
 recipientId True string

ID příjemce

Návraty

Body
RecipientTabsResponse

Získání polí formuláře generování dokumentu z obálky

ID operace:
GetDocgenFormFields

Získání polí formuláře generování dokumentu z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky

Návraty

Body
DocGenFormFieldsResponse

Získání seznamu událostí auditu

ID operace:
GetAuditEvents

Získání seznamu událostí auditu

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky

Návraty

response
object

Získání vlastních polí dokumentu z obálky

ID operace:
GetEnvelopeDocumentFields

Získání vlastních polí dokumentu z obálky

Parametry

Name Klíč Vyžadováno Typ Description
Account
 accountId True string

ID účtu
Obálka
 envelopeId True string

ID obálky
ID dokumentu
 documentId True string

ID dokumentu

Návraty

Body
ListEnvelopeDocumentFieldsResponse

Aktivační události

Když se změní stav obálky (Připojit) (V3)

Aktivuje nový tok, když se změní stav obálky.
ZASTARALÉ: Když se změní stav obálky (Připojit)

Aktivuje nový tok, když se změní stav obálky.
ZASTARALÉ: Při změně stavu obálky (Připojení) (V2)

Aktivuje nový tok, když se změní stav obálky.

Když se změní stav obálky (Připojit) (V3)

ID operace:
CreateHookEnvelopeV3

Aktivuje nový tok, když se změní stav obálky.

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

Body
WebhookEnvelopeResponseV2

ZASTARALÉ: Když se změní stav obálky (Připojit)

ID operace:
CreateHookEnvelope

Aktivuje nový tok, když se změní stav obálky.

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

Body
WebhookEnvelopeResponse

ZASTARALÉ: Při změně stavu obálky (Připojení) (V2)

ID operace:
CreateHookEnvelopeV2

Aktivuje nový tok, když se změní stav obálky.

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

Body
WebhookEnvelopeResponseV2

Definice

WebhookEnvelopeResponseV2

Name Cesta Typ Description
Vlastní pole
 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
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
 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

SalesCopilotFilteredEnvelopes

Name Cesta Typ Description
Title
 title string

Název obálky
Podtitul
 subTitle string

Podtitle obálky
URL
 url string

Adresa URL obálky
Další vlastnosti
 additionalPropertiesForSalesEnvelope.additionalPropertiesForSalesEnvelope string

Další vlastnosti

Activity

Name Cesta Typ Description
Title
 title string

Tento výstup označuje název aktivity na citační kartě.
Description
 description string

Tento výstup označuje popis přehledu.
DateTime
 dateTime date-time

Tento výstup označuje čas přidružený k přehledu.
URL
 url string

Tento výstup označuje adresu URL pro otevření přehledu.
Další vlastnosti
 additionalProperties.additionalProperties string

Další vlastnosti aktivity

EmailSummary

Name Cesta Typ Description
Title
 Title string

Tento výstup označuje název oddílu partnera a měl by obsahovat pouze jméno partnera.
popis
 Description string

Tento výstup označuje text, který chcete zahrnout do souhrnu e-mailu.

Klávesové zkratky

Name Cesta Typ Description
Title
 Title string

Tento výstup označuje název karty citace pro poznatek.
popis
 description string

Tento výstup označuje text přehledu, který se má zahrnout do klíčových údajů o prodeji.
Adresa URL obálky
 url string

Tento výstup označuje adresu URL, která obsahuje další informace o přehledu.
Čas spojený s přehledem
 dateTime string

Tento výstup označuje čas přidružený k přehledu.
Další vlastnosti
 additionalProperties.additionalProperties string

Tento výstup uvádí další vlastnosti jako páry název-hodnota každého získaného poznatku vráceného akcí.

DokumentZáznam

Name Cesta Typ Description
ID záznamu
 recordId string

Tento výstup jednoznačně identifikuje každý související záznam vrácený akcí.
Zobrazovaný název typu záznamu
 recordTypeDisplayName string

Tento výstup označuje zobrazovaný název typu záznamu každého souvisejícího záznamu vráceného akcí.
Zobrazovaný název typu záznamu v množném čísle
 recordTypePluralDisplayName string

Tento výstup označuje zobrazovaný název množného čísla typu záznamu každého souvisejícího záznamu vráceného akcí.
Typ záznamu
 recordType string

Tento výstup označuje typ každého souvisejícího záznamu vráceného akcí.
Název záznamu
 recordTitle string

Tento výstup označuje název každého souvisejícího záznamu vráceného akcí.
Adresa URL obálky
 url string

Tento výstup označuje adresu URL každého souvisejícího záznamu vráceného akcí.
Další vlastnosti
 additionalProperties.additionalProperties string

Tento výstup označuje další vlastnosti jako dvojice název-hodnota každého souvisejícího záznamu vráceného akcí.

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.

FiltrovanéSalesCopilotEnvelopeListResponse

Name Cesta Typ Description
Filtrované obálky
 value array of SalesCopilotFilteredEnvelopes

Filtrované obálky
má více výsledků
 hasMoreResults boolean

ActivityListResponseEnvelope

Name Cesta Typ Description
Související aktivity
 value array of Activity

Související aktivity
má více výsledků
 hasMoreResults boolean

EmailSummaryResponse

Name Cesta Typ Description
Shrnutí e-mailu
 value array of EmailSummary

Key Sales
má více výsledků
 hasMoreResults boolean

KeySalesResponse

Name Cesta Typ Description
Key sales'
 value array of KeySales

Key Sales
má více výsledků
 hasMoreResults boolean

DocumentRecordListResponseEnvelope

Name Cesta Typ Description
Související záznamy
 value array of DocumentRecord

Související záznamy
má více výsledků
 hasMoreResults boolean

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
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
 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

Důvod odmítnutí

objekt

Toto je typ "object".

Použití tohoto konektoru