Docusign Demo (förhandsversion)
Docusign gör det möjligt för organisationer att skapa, checka in och hantera sina avtal under hela avtalslivscykeln. Kunder kan öka intäkterna, minska risken och låsa upp värde från de avtal som driver deras verksamhet. Docusign Demo-anslutningsappen ansluter endast till Docusign-demomiljöer men erbjuder samma funktioner som docuSign-anslutningsappen för produktion. Alla avtal i en Docusign-demomiljö är inte juridiskt bindande.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänster | Class | Regioner |
|---|---|---|
| Copilot Studio | Norm | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Norm | Alla Logic Apps-regioner utom följande: - Azure kinaregioner - US Department of Defense (DoD) |
| Power Apps | Norm | Alla Power Apps regioner förutom följande: - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Norm | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Namn | docusign |
| URL | https://support.docusign.com |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | DocuSign, Inc. |
| Webbplats | https://www.docusign.com |
| Sekretesspolicy | https://www.docusign.com/company/privacy-policy |
| Kategorier | Innehåll och filer; Produktivitet |
Titel
DocuSign hjälper organisationer att ansluta och automatisera hur de förbereder, signerar, agerar på och hanterar avtal. DocuSign Demo-anslutningsappen ansluter endast till DocuSign Demo-miljöer men har samma funktioner som den vanliga DocuSign-anslutningsappen. Alla dokument i en DocuSign Demo-miljö är inte juridiskt bindande. För alla icke-demo-användningar använder du den vanliga DocuSign-anslutningsappen.
Förutsättningar
Om du vill använda Connect-utlösaren i den här integreringen måste DocuSign Connect vara aktiverat i ditt DocuSign-konto. Den är inte aktiverad som standard. När den är aktiverad kan sidan Anslut inställningar nås från webbprogrammet DocuSign Admin. Om du använder Connect-utlösaren i den här integreringen registreras webhooken automatiskt åt dig.
Hämta autentiseringsuppgifter
Om du vill prova anslutningsappen använder du ett DEMO-konto:
- Gå till https://developers.docusign.com/
- Skapa sandbox-konto.
Dessa skiljer sig från kostnadsfria utvärderingsversioner eftersom de aldrig upphör att gälla, har 90% av våra betalkontofunktioner och inget av dokumenten som skickas via DEMO är juridiskt bindande (https://support.docusign.com/en/articles/Free-account-vs-Developer-account).
Dokumentation om anslutningsprogram
Detaljerad dokumentation om anslutningsappen finns i https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
Kända problem och begränsningar
Om du har problem med DocuSign kan du prova den här länken först: https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center.
Distributionsinstruktioner
Använd de här instruktionerna för att distribuera den här anslutningsappen som anpassad anslutningsapp i Microsoft Power Automate och Power Apps.
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 250 | 60 sekunder |
Åtgärder
| Generera inbäddad signerings-URL (V2) |
Generera inbäddad signerings-URL (V2) |
| Generera inbäddad signerings-URL [INAKTUELL] |
Generera inbäddad signerings-URL |
| Generera url för inbäddad avsändare |
Generera url för inbäddad avsändare |
| Hämta anpassad fältinformation för kuvert |
Hämta information om anpassade kuvertfält. |
| Hämta dokument från ett kuvert |
Hämta dokument från ett kuvert |
| Hämta dokumentanpassade fält från kuvert |
Hämta dokumentanpassade fält från kuvert |
| Hämta dokumentflikar från kuvert |
Hämta dokumentflikar från kuvert |
| Hämta dokumentflikar från mallen |
Hämta dokumentflikar från mallen |
| Hämta dokumentinformation från kuvertet |
Hämta dokumentinformation från kuvertet |
| Hämta formulärfält för dokumentgenerering från kuvert |
Hämta formulärfält för dokumentgenerering från kuvert |
| Hämta formulärfält för dokumentgenerering från mallen (endast massutskick av mallar) |
Hämta formulärfält för dokumentgenerering från mallen (endast massutskick av mallar) |
| Hämta granskningshändelselista |
Hämta granskningshändelselista |
| Hämta information för fliken Mottagare |
Returnerar värdet för fliken för den angivna mottagaren |
| Hämta mottagarflikar från kuvert |
Hämta mottagarflikar från kuvert |
| Hämta mottagarinformation från kuvertet |
Hämta mottagarinformation från kuvertet |
| INAKTUELL: Hämta dokument från kuvert (inaktuell) [INAKTUELL] |
Hämta dokument från kuvertet (inaktuellt) |
| INAKTUELL: Lägg till mottagare i ett kuvert (inaktuellt) [INAKTUELLT] |
Lägg till mottagaren i ett kuvert (inaktuellt). |
| INAKTUELL: Skapa kuvert med mall (inaktuell) [INAKTUELL] |
Skapa ett nytt kuvert med en angiven mall (inaktuell). |
| Lista kuvert |
Den här åtgärden returnerar relevanta Docusign-kuvert baserat på kuvertstatus, datumintervall, mottagarnamn, mottagarens e-postadress, kuvertrubrik, dokumentnamn eller kuvertets anpassade fältvärde. Utdata är rubrik, beskrivning, kuvert-ID, dokumentnamn, avsändarnamn, kuvertstatus, statusdatum, skickat datum och en URL för kuvertet som kan användas som en länk för att visa kuvertet i Docusign. |
| Lista mallar |
Lista mallar för ett specifikt konto. |
| Lista mottagare från ett kuvert |
Lista mottagare från ett kuvert |
| Logga in |
Logga in |
| Lägga till dokument i ett kuvert |
Lägg till dokument i ett kuvert. |
| Lägga till flikar för en mottagare på ett kuvert |
Lägga till flikar för en mottagare på ett kuvert |
| Lägga till mottagare i ett kuvert (V2) |
Lägg till mottagaren i ett kuvert. |
| Lägga till påminnelser för ett kuvert |
Lägga till påminnelser för ett kuvert |
| Lägga till verifieringstyp till en mottagare |
Lägg till verifieringstyp till en mottagare. |
| Massutskicka kuvert med mall |
Massutskicka kuvert med mall |
| Ogiltigförklara kuvertet |
Ogiltigt kuvertet. |
| Skapa kuvert (V2) |
Skapa ett nytt tomt kuvert. |
| Skapa kuvert med hjälp av mall med mottagare |
Skapa ett nytt kuvert med en angiven mall och ange mottagare. |
| Skapa kuvert med hjälp av mall med mottagare och flikar |
Skapa kuvert med hjälp av mall med mottagare och flikar |
| Skapa kuvert med mall |
Skapa ett nytt kuvert med en angiven mall. |
| Skapa kuvert med sammansatta mallar |
Skapa kuvert med sammansatta mallar |
| Skapa masssändningslista |
Skapa masssändningslista |
| Skicka kuvert |
Skicka ett befintligt kuvert. |
| Skicka kuvertet igen |
Den här åtgärden skickar om ett Docusign-kuvert eller skickar en påminnelse till mottagare som behöver signera ett Docusign-avtal baserat på ett angivet EnvelopeId. |
| Starta Docusign-arbetsflöde |
Starta Docusign-arbetsflöde |
| Ta bort mottagaren från ett kuvert |
Ta bort mottagaren från ett kuvert |
| Tillämpa en mall på dokument |
Tillämpa en mall på dokument |
| Uppdatera anpassat kuvertfält |
Uppdatera värde för det angivna anpassade kuvertfältet |
| Uppdatera formulärfält för dokumentgenerering från kuvert |
Uppdatera formulärfält för dokumentgenerering från kuvert |
| Uppdatera kuvertförfyllnadsflikar |
Uppdatera värden för en lista med förfyllningsflikar |
| Uppdatera mottagaren på ett kuvert |
Uppdatera mottagaren på ett kuvert |
| Uppdatera tabbvärden för mottagare på ett kuvert |
Uppdatera tabbvärden för mottagare på ett kuvert |
| Visa en lista över dokument från en mall |
Visa en lista över dokument från en mall |
| Visa en lista över dokument från ett kuvert |
Visa en lista över dokument från ett kuvert |
| Visa versionsnummer (endast som referens. Inkludera inte i ett flöde för körning) |
Identifierare för den distribuerade versionen. |
Generera inbäddad signerings-URL (V2)
Generera inbäddad signerings-URL (V2)
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Är det här en personlig undertecknare?
|
isInPersonSigner | True | string |
Yes/No |
|
Autentiseringsmetod
|
authenticationMethod | True | string |
Autentiseringsmetod |
|
Returnera URL
|
returnUrl | True | string |
Returnera URL |
|
Ytterligare url har lagts till
|
additionalURL | True | dynamic |
Ytterligare url har lagts till. |
Returer
Generera inbäddad signerings-URL [INAKTUELL]
Generera inbäddad signerings-URL
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Namn på undertecknare
|
signerName | True | string |
Namn på undertecknare |
|
E-post för undertecknare
|
signerEmail | True | string |
E-post för undertecknare |
|
Klientanvändar-ID
|
clientUserId | string |
Krävs om inte undertecknaren är personlig. Lämna tomt för personliga undertecknare |
|
|
Autentiseringsmetod
|
authenticationMethod | True | string |
Autentiseringsmetod |
|
Returnera URL
|
returnUrl | True | string |
Returnera URL |
|
Ytterligare url har lagts till
|
additionalURL | dynamic |
Ytterligare url har lagts till. |
Returer
Generera url för inbäddad avsändare
Generera url för inbäddad avsändare
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Öppna i
|
openIn | True | string |
Öppna i |
|
Returnera URL
|
returnUrl | True | string |
Returnera URL |
|
Ytterligare url har lagts till
|
additionalURL | dynamic |
Ytterligare url har lagts till. |
Returer
Hämta anpassad fältinformation för kuvert
Hämta information om anpassade kuvertfält.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Namn på anpassat fält
|
fieldName | True | string |
Namn på anpassat fält |
Returer
Hämta dokument från ett kuvert
Hämta dokument från ett kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Utdataformat
|
documentId | True | string |
Ange "string(document ID)" för att hämta ett enskilt dokument eller välj ett format. |
|
Språk för slutförande av certifikat (valfritt)
|
language | string |
Välj språk |
Returer
- response
- GetDocumentsResponse
Hämta dokumentanpassade fält från kuvert
Hämta dokumentanpassade fält från kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Dokument-ID
|
documentId | True | string |
Ange ett dokument-ID. |
Returer
Hämta dokumentflikar från kuvert
Hämta dokumentflikar från kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Dokument-ID
|
documentId | True | string |
Ange ett dokument-ID. |
Returer
- Body
- ListTabsResponse
Hämta dokumentflikar från mallen
Hämta dokumentflikar från mallen
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Mall-id
|
templateId | True | string |
Ange eller välj ett mall-ID. |
|
Dokument-ID
|
documentId | True | string |
Ange ett dokument-ID. |
Returer
- Body
- ListTabsResponse
Hämta dokumentinformation från kuvertet
Hämta dokumentinformation från kuvertet
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Dokumentnamn
|
documentName | True | string |
Filnamn med filnamnstillägg |
Returer
- Body
- EnvelopeDocument
Hämta formulärfält för dokumentgenerering från kuvert
Hämta formulärfält för dokumentgenerering från kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
Returer
Hämta formulärfält för dokumentgenerering från mallen (endast massutskick av mallar)
Hämta formulärfält för dokumentgenerering från mallen (endast massutskick av mallar)
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Mall-id
|
templateId | True | string |
Ange eller välj ett mall-ID. |
Returer
Formulärfält för dokumentgenerering från mallen
- DocGen-mallfält
- object
Hämta granskningshändelselista
Hämta granskningshändelselista
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
Returer
- response
- object
Hämta information för fliken Mottagare
Returnerar värdet för fliken för den angivna mottagaren
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Mottagarens ID
|
recipientId | True | string |
Ange ett mottagar-ID. |
|
Tabbetikett
|
tabLabel | True | string |
Tabbetikett |
Returer
- Body
- Tab
Hämta mottagarflikar från kuvert
Hämta mottagarflikar från kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Mottagarens ID
|
recipientId | True | string |
Ange ett mottagar-ID. |
Returer
Hämta mottagarinformation från kuvertet
Hämta mottagarinformation från kuvertet
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
E-postmottagare
|
recipientEmail | string |
E-postmottagare |
|
|
Riktnummer
|
areaCode | string |
Mottagarens riktnummer |
|
|
Telefonnummer
|
phoneNumber | string |
Mottagarens telefonnummer |
|
|
Mottagarens ID
|
recipientId | string |
Ange ett mottagar-ID. |
Returer
- Body
- Signer
INAKTUELL: Hämta dokument från kuvert (inaktuell) [INAKTUELL]
Hämta dokument från kuvertet (inaktuellt)
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Konto-ID |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Certifikat för slutförande
|
certificate | True | boolean |
När värdet är falskt tas certifikatet för kuvertsignering bort från nedladdningen. |
Returer
- response
- GetDocumentsResponse
INAKTUELL: Lägg till mottagare i ett kuvert (inaktuellt) [INAKTUELLT]
Lägg till mottagaren i ett kuvert (inaktuellt).
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Konto-ID |
|
Kuvert
|
envelopeId | True | string |
Kuvert-ID |
|
Namn på undertecknare
|
AddRecipientToEnvelopeName | True | string |
Namnet på mottagaren. |
|
E-post för undertecknare
|
AddRecipientToEnvelopeEmail | True | string |
Mottagarens e-postadress. |
|
Signeringsorder
|
routingOrder | string |
Mottagarens signeringsordning i dokumentet. |
|
|
Role
|
roleName | string |
Undertecknarens roll. |
Returer
INAKTUELL: Skapa kuvert med mall (inaktuell) [INAKTUELL]
Skapa ett nytt kuvert med en angiven mall (inaktuell).
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Mall-id
|
templateId | True | string |
Ange eller välj ett mall-ID. |
|
Kuvertstatus
|
status | True | string |
Kuvertstatus |
|
Anpassade fält
|
accountCustomFields | True | dynamic |
Hämta de anpassade fälten som angetts på kontonivå. |
Returer
Lista kuvert
Den här åtgärden returnerar relevanta Docusign-kuvert baserat på kuvertstatus, datumintervall, mottagarnamn, mottagarens e-postadress, kuvertrubrik, dokumentnamn eller kuvertets anpassade fältvärde. Utdata är rubrik, beskrivning, kuvert-ID, dokumentnamn, avsändarnamn, kuvertstatus, statusdatum, skickat datum och en URL för kuvertet som kan användas som en länk för att visa kuvertet i Docusign.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Mottagarens namn
|
recipientName | string |
Den här åtgärden visar kuvert baserat på mottagarens namn |
|
|
E-postmottagare
|
recipientEmailId | string |
Filtrerar kuvert efter mottagarens e-post |
|
|
Kuvertämne
|
envelopeTitle | string |
Filtrerar kuvert efter kuvertämne |
|
|
Namn på anpassat fält
|
customFieldName | string |
Den här åtgärden listar kuvert baserat på ett namn på dess anpassade fält |
|
|
Värde för anpassat fält
|
customFieldValue | string |
Filter efter anpassat fältvärde |
|
|
Sök ord
|
search_text | string |
Ange ett nyckelord för att hitta matchningar i kuvertämnen, mottagare och anpassade fält. |
|
|
Kuvertstatus
|
envelopeStatus | string |
Den här åtgärden visar kuvert baserat på kuvertets status |
|
|
Mapp
|
folder_ids | string |
Filtrerar kuvert efter den valda mappen |
|
|
Sortera efter
|
order_by | string |
Sorterar kuvert i den valda ordningen |
|
|
Returnera kuvert
|
top | integer |
Ange antalet kuvert som ska returneras (standardvärdet är 10, max är 1 000) |
|
|
Hoppa över kuvert
|
skip | integer |
Ange hur många kuvert som ska hoppa från början |
|
|
Startdatum
|
from_date | date-time |
Ange startdatum-tid i UTC-format: 2017-05-02T01:44z |
|
|
Slutdatum
|
to_date | date-time |
Ange slutdatum i UTC-format: 2017-05-02T01:44z. |
Returer
Lista mallar
Lista mallar för ett specifikt konto.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
Returer
Lista mottagare från ett kuvert
Lista mottagare från ett kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
Returer
Logga in
Lägga till dokument i ett kuvert
Lägg till dokument i ett kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Dokumentbas64 *
|
documentBase64 | True | string |
Base64 av dokumentinnehåll |
|
Dokumenttyp *
|
fileExtension | True | string |
pdf, docx osv. |
|
Dokumentnamn *
|
name | True | string |
dokumentnamn |
|
Transformera PDF-fält
|
transformPdfFields | string |
Falsk |
|
|
Tilldela flikar till mottagaren
|
assignTabsToRecipientId | string |
Mottagarens ID |
Returer
- Body
- AddDocumentsResponse
Lägga till flikar för en mottagare på ett kuvert
Lägga till flikar för en mottagare på ett kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Mottagarens ID
|
recipientId | True | string |
Ange ett mottagar-ID. |
|
Fliktyp
|
tabType | True | string |
Fliktyp |
|
flikinformation
|
tabDetails | True | dynamic |
Information om den markerade fästpunktsfliken. |
Returer
Lägga till mottagare i ett kuvert (V2)
Lägg till mottagaren i ett kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Mottagartyp
|
recipientType | True | string |
Ange eller välj en mottagartyp. |
|
Klientanvändar-ID
|
clientUserId | string |
Klientanvändar-ID för inbäddad undertecknare |
|
|
Mottagarens ID
|
recipientId | string |
Ange ett mottagar-ID. |
|
|
Start-URL för inbäddad mottagare
|
embeddedRecipientStartURL | string |
En URL-sträng som tillhandahålls av avsändaren för omdirigering av en inbäddad mottagare. |
|
|
Signeringsordning
|
routingOrder | string |
Mottagarens signeringsordning. |
|
|
E-postaviseringsspråk
|
emailNotificationLanguage | string |
Språk för e-postmeddelandet. |
|
|
Ämne för e-postavisering
|
emailNotificationSubject | string |
Ämne för e-postmeddelandet. |
|
|
Brödtext för e-postavisering
|
emailNotificationBody | string |
Brödtexten i e-postmeddelandet. |
|
|
Anmärkning
|
note | string |
Anpassad anteckning för mottagaren. |
|
|
Rollnamn
|
roleName | string |
Rollnamn som är associerat med mottagaren. |
|
|
SMS-landskod
|
countryCode | string |
För SMS-meddelanden, landskoden, utan inledande + tecken. |
|
|
SMS-telefonnummer
|
phoneNumber | string |
Signerarens e-post eller SMS-telefon krävs. Exkludera landskod för telefonnummer. |
|
|
Signeringsgrupp
|
signingGroupId | string |
Signeringsgrupp |
|
|
Signaturtyp
|
signatureType | string |
DocuSign standards-based-signature (SBS) typer. |
|
|
Verifieringsarbetsflöde
|
workflowId | string |
IDV-arbetsflöden med pennsignaturtyper måste väljas här. |
|
|
information om vald mottagartyp
|
additionalRecipientParams | dynamic |
Information om vald mottagartyp. |
Returer
- Body
- Signer
Lägga till påminnelser för ett kuvert
Lägga till påminnelser för ett kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Påminnelse aktiverad
|
reminderEnabled | True | boolean |
När påminnelserna är inställda på false inaktiveras de. Standardvärdet är falskt |
|
Påminnelsefördröjning
|
reminderDelay | True | string |
Lägg till antal dagar efter vilken mottagaren får påminnelser via e-post. |
|
Påminnelsefrekvens
|
reminderFrequency | True | string |
Lägg till antal dagar mellan e-postpåminnelser. |
|
Upphör att gälla efter
|
expireAfter | string |
Lägg till antal dagar före förfallodatum. |
Returer
- Body
- AddRemindersResponse
Lägga till verifieringstyp till en mottagare
Lägg till verifieringstyp till en mottagare.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Mottagarens ID
|
recipientId | True | string |
Ange ett mottagar-ID. |
|
Mottagartyp
|
recipientType | True | string |
Ange eller välj en mottagartyp. |
|
Verifieringstyp
|
verificationType | True | string |
Verifieringstyp |
|
Ytterligare mottagardata
|
additionalRecipientData | dynamic |
Ytterligare mottagardata. |
Massutskicka kuvert med mall
Massutskicka kuvert med mall
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
GUID för massutskickslista
|
bulkSendListId | True | string |
GUID för massutskickslista |
|
Mall-id
|
envelopeOrTemplateId | True | string |
Ange mall-ID:t eller välj en mall i listrutan |
Returer
- Body
- BulkSendListGuid
Ogiltigförklara kuvertet
Ogiltigt kuvertet.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Orsak till ogiltighet
|
voidedReason | True | string |
Ogiltig orsak |
Returer
- response
- object
Skapa kuvert (V2)
Skapa ett nytt tomt kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Ämne för e-post
|
emailSubject | True | string |
Ämne för e-postmeddelandet. |
|
body
|
body | dynamic |
Anpassade fält för e-posttext och konto. |
Returer
Skapa kuvert med hjälp av mall med mottagare
Skapa ett nytt kuvert med en angiven mall och ange mottagare.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvertstatus
|
status | True | string |
Kuvertstatus |
|
Mall-id
|
templateId | True | string |
Ange eller välj ett mall-ID. |
|
Undertecknarna
|
signers | dynamic |
Undertecknarna av dokumentet. |
|
|
Ämne för e-post
|
emailSubject | string |
Ämne för e-post |
|
|
E-postbrödtext
|
emailBody | string |
E-postbrödtext |
Returer
Skapa kuvert med hjälp av mall med mottagare och flikar
Skapa kuvert med hjälp av mall med mottagare och flikar
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Mall-id
|
templateId | True | string |
Ange eller välj ett mall-ID. |
|
Mottagare
|
recipients | dynamic |
Undertecknarna av dokumentet. |
|
|
Sammanfoga roller och ta bort tomma mottagare
|
merge_roles_on_draft | string |
Sammanfoga roller och ta bort tomma mottagare |
|
|
Ämne för e-post
|
emailSubject | string |
Ämne för e-post |
Returer
Skapa kuvert med mall
Skapa ett nytt kuvert med en angiven mall.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Mall-id
|
templateId | True | string |
Ange eller välj ett mall-ID. |
|
Kuvertstatus
|
status | True | string |
Kuvertstatus |
Returer
Skapa kuvert med sammansatta mallar
Skapa kuvert med sammansatta mallar
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Ämne för e-post
|
emailSubject | True | string |
Ämne för e-postmeddelandet. |
|
E-postbrödtext
|
emailBody | string |
Brödtext för e-postmeddelandet. |
|
|
Kuvertstatus
|
status | True | string |
Kuvertstatus |
|
Sammanfoga roller och ta bort tomma mottagare
|
merge_roles_on_draft | string |
Sammanfoga roller och ta bort tomma mottagare |
|
|
body
|
body | dynamic |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kuvert-ID
|
envelopeId | string |
Kuvertets ID. |
|
Läge
|
status | string |
Kuvertets status. |
|
Datumtid för status
|
statusDateTime | string |
Datetime som statusen angavs. |
|
URI
|
uri | string |
URI:n för kuvertet i DocuSign. |
Skapa masssändningslista
Skapa masssändningslista
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Namn på masssändningslista
|
name | True | string |
Namn på masssändningslista |
|
CSV-fil
|
csv | string |
Ladda upp CSV-fil |
|
|
Fält för dokumentgenerering
|
rawOutput | object |
Fält för dokumentgenerering |
Returer
- Body
- BulkSendListGuid
Skicka kuvert
Skicka ett befintligt kuvert.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
Returer
- response
- object
Skicka kuvertet igen
Den här åtgärden skickar om ett Docusign-kuvert eller skickar en påminnelse till mottagare som behöver signera ett Docusign-avtal baserat på ett angivet EnvelopeId.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
Returer
- response
- object
Starta Docusign-arbetsflöde
Starta Docusign-arbetsflöde
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
arbetsflöde
|
workflowId | True | string |
Ange arbetsflödes-ID:t eller välj arbetsflödesnamnet i listrutan |
|
instansnamn
|
instanceName | True | string |
Namnet på arbetsflödesinstansen |
|
variable
|
variable | dynamic |
Returer
TriggerMaestroFlowResponse
- response
- object
Ta bort mottagaren från ett kuvert
Ta bort mottagaren från ett kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Mapp
|
folderId | True | string |
Mapp-ID |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Mottagarens ID
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
Mottagarens ID |
Returer
Tillämpa en mall på dokument
Tillämpa en mall på dokument
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Mall-id
|
templateId | True | string |
Ange eller välj ett mall-ID. |
|
Bevara mallmottagare
|
preserve_template_recipient | string |
Falsk |
|
|
Dokument-ID
|
documentId | True | string |
Dokument-ID |
|
Startsida för dokument
|
documentStartPage | True | string |
Startsida för dokument |
|
Dokumentets slutsida
|
documentEndPage | True | string |
Dokumentets slutsida |
Uppdatera anpassat kuvertfält
Uppdatera värde för det angivna anpassade kuvertfältet
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Fält-ID
|
fieldId | True | string |
Anpassat fält-ID |
|
Fälttyp
|
fieldType | True | string |
Anpassad fälttyp |
|
Namn
|
name | True | string |
Namn på anpassat fält |
|
Värde
|
value | True | string |
Anpassat fältvärde |
Returer
Uppdatera formulärfält för dokumentgenerering från kuvert
Uppdatera formulärfält för dokumentgenerering från kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Dokument-GUID
|
documentGuid | True | string |
Dokument-GUID |
|
Typ
|
fieldType | string |
Välj vilken typ av dokumentgenereringsfält som ska uppdateras |
|
|
Namn
|
name | string |
Ange fältnamnet eller tabellkolumnnamnet |
|
|
Värde
|
value | string |
Ange fältdata |
|
|
Etikett
|
label | string |
Krävs för "Tabellrad". Ange etiketten för docgen-fältet. |
|
|
: Tabellnamn
|
tableName | string |
Krävs för "Tabellrad". Ange tabellnamnet. |
|
|
: Tabellrad
|
rowNumber | string |
Krävs för "Tabellrad". Ange radnumret |
Uppdatera kuvertförfyllnadsflikar
Uppdatera värden för en lista med förfyllningsflikar
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Dokument-ID
|
documentId | True | string |
Ange ett dokument-ID. |
|
Typ
|
tabType | string |
Typ |
|
|
ID
|
tabId | string |
ID |
|
|
Värde
|
value | string |
Värde |
Uppdatera mottagaren på ett kuvert
Uppdatera mottagaren på ett kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Mottagarens ID
|
recipientId | True | string |
Ange ett mottagar-ID. |
|
Signaturtyp
|
signatureType | string |
DocuSign standards-based-signature (SBS) typer. |
|
|
Mottagartyp
|
recipientType | True | string |
Mottagartyp |
|
Klientanvändar-ID
|
clientUserId | string |
Klientanvändar-ID för inbäddad undertecknare |
|
|
Start-URL för inbäddad mottagare
|
embeddedRecipientStartURL | string |
En URL-sträng som tillhandahålls av avsändaren för omdirigering av en inbäddad mottagare. |
|
|
Signeringsordning
|
routingOrder | string |
Mottagarens signeringsordning. |
|
|
E-postaviseringsspråk
|
emailNotificationLanguage | string |
Språk för e-postmeddelandet. |
|
|
Ämne för e-postavisering
|
emailNotificationSubject | string |
Ämne för e-postmeddelandet. |
|
|
Brödtext för e-postavisering
|
emailNotificationBody | string |
Brödtexten i e-postmeddelandet. |
|
|
Anmärkning
|
note | string |
Anpassad anteckning för mottagaren. |
|
|
Rollnamn
|
roleName | string |
Rollnamn som är associerat med mottagaren. |
|
|
SMS-landskod
|
countryCode | string |
För SMS-meddelanden, landskoden, utan inledande + tecken. |
|
|
SMS-telefonnummer
|
phoneNumber | string |
Signerarens e-post eller SMS-telefon krävs. Exkludera landskod för telefonnummer. |
|
|
Signeringsgrupp
|
signingGroupId | string |
Signeringsgrupp |
|
|
information om vald mottagartyp
|
additionalRecipientParams | dynamic |
Information om vald mottagartyp. |
Returer
- Body
- Signer
Uppdatera tabbvärden för mottagare på ett kuvert
Uppdatera tabbvärden för mottagare på ett kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
|
Mottagarens ID
|
recipientId | True | string |
Ange ett mottagar-ID. |
|
Typ
|
tabType | string |
Fliktyp |
|
|
ID
|
tabId | string |
ID |
|
|
Värde
|
value | string |
Värde |
Visa en lista över dokument från en mall
Visa en lista över dokument från en mall
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Mall-id
|
templateId | True | string |
Ange eller välj ett mall-ID. |
Returer
Visa en lista över dokument från ett kuvert
Visa en lista över dokument från ett kuvert
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange eller välj ett konto-ID. |
|
Kuvert-ID
|
envelopeId | True | string |
Ange ett kuvert-ID. |
Returer
Visa versionsnummer (endast som referens. Inkludera inte i ett flöde för körning)
Identifierare för den distribuerade versionen.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Byggnummer
|
buildNumber | dynamic |
Returer
- response
- object
Utlösare
| INAKTUELL: När en kuvertstatus ändras (Anslut) (inaktuell) [INAKTUELL] |
Utlöser ett nytt flöde när en kuvertstatus ändras (inaktuell). |
| INAKTUELL: När en kuvertstatus ändras (Anslut) (V2) (inaktuell) [INAKTUELL] |
Utlöser ett nytt flöde när en kuvertstatus ändras (inaktuell). |
| När en Docusign Connect-händelse inträffar (kontonivå) |
Utlöser ett nytt flöde när en kuvertstatus ändras. |
| När en Docusign Connect-händelse inträffar (organisationsnivå) |
Utlöser ett nytt flöde när en kuvertstatus ändras. |
INAKTUELL: När en kuvertstatus ändras (Anslut) (inaktuell) [INAKTUELL]
Utlöser ett nytt flöde när en kuvertstatus ändras (inaktuell).
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Konto-ID |
|
Anslut namn
|
name | True | string | |
|
Kuverthändelse
|
envelopeEvents | True | string |
Returer
INAKTUELL: När en kuvertstatus ändras (Anslut) (V2) (inaktuell) [INAKTUELL]
Utlöser ett nytt flöde när en kuvertstatus ändras (inaktuell).
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
Konto-ID |
|
Anslut namn
|
name | True | string | |
|
Kuverthändelse
|
envelopeEvents | True | string |
Returer
När en Docusign Connect-händelse inträffar (kontonivå)
Utlöser ett nytt flöde när en kuvertstatus ändras.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Konto-ID
|
accountId | True | string |
Ange ett konto-ID eller välj ett konto i listrutan. |
|
Anslut konfigurationsnamn
|
name | True | string |
Namnge din Connect-konfiguration (till exempel "Kuverthändelser"). |
|
Utlösarhändelser
|
events | True | array of string |
Välj en händelse. Om du vill inkludera en annan händelse väljer du "Lägg till nytt objekt". |
Returer
När en Docusign Connect-händelse inträffar (organisationsnivå)
Utlöser ett nytt flöde när en kuvertstatus ändras.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Organisations-ID
|
organizationId | True | string |
Ange eller välj ett organisations-ID. |
|
Anslut konfigurationsnamn
|
name | True | string |
Namnge din Connect-konfiguration (till exempel "Kuverthändelser"). |
|
Utlösarhändelser
|
events | True | array of string |
Välj en händelse. Om du vill inkludera en annan händelse väljer du "Lägg till nytt objekt". |
Returer
Definitioner
WebhookEnvelopeResponseV2
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Anpassade kuvertfält
|
data.envelopeSummary.customFields | object |
Nyckel/värde-par som representerar de anpassade fälten för det här kuvertet (där nyckeln är fältnamnet och värdet är fältvärdet). |
|
Kuvert skapat Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
åååå-MM-ddTHH:mm:ss.fffZ |
|
Kuvert-ID
|
data.envelopeSummary.envelopeId | string | |
|
Kuvert skickat Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
åååå-MM-ddTHH:mm:ss.fffZ |
|
Kuvertstatus
|
data.envelopeSummary.status | string | |
|
E-postämne
|
data.envelopeSummary.emailSubject | string | |
|
kuvertDokument
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
Dokument-ID
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Dokument-GUID
|
data.envelopeSummary.envelopeDocuments.documentGuid | string | |
|
Dokumentnamn
|
data.envelopeSummary.envelopeDocuments.documentName | string | |
|
Avsändarens namn
|
data.envelopeSummary.sender.userName | string | |
|
Avsändarens användar-ID
|
data.envelopeSummary.sender.userId | string | |
|
Avsändarens konto-ID
|
data.envelopeSummary.sender.accountId | string | |
|
Avsändarens e-postadress
|
data.envelopeSummary.sender.email | string | |
|
Undertecknarna
|
data.envelopeSummary.recipients.signers | array of object | |
|
Flikar
|
data.envelopeSummary.recipients.signers.tabs | object |
Nyckel/värde-par som representerar flikarna för den här mottagaren (där nyckeln är fältnamnet och värdet är fältvärdet). |
|
E-postmottagare
|
data.envelopeSummary.recipients.signers.email | string | |
|
Mottagarens ID
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Routningsordning
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Mottagaren skickade Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
åååå-MM-ddTHH:mm:ss.fffZ |
|
Mottagarstatus
|
data.envelopeSummary.recipients.signers.status | string |
Mottagarens status. |
|
Mottagartyp
|
data.envelopeSummary.recipients.signers.recipientType | string |
Typ av mottagare. |
|
Verifieringstyp
|
data.envelopeSummary.recipients.signers.verificationType | string |
Typen av verifiering. |
|
Mottagarnamn
|
data.envelopeSummary.recipients.signers.name | string |
Namnet på mottagaren. |
WebhookOrganizationResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Organisations-ID
|
data.organizationId | string |
Organisations-ID. |
|
Anpassade kuvertfält
|
data.envelopeSummary.customFields | object |
Nyckel/värde-par som representerar de anpassade fälten för det här kuvertet (där nyckeln är fältnamnet och värdet är fältvärdet). |
|
Kuvert skapat Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
åååå-MM-ddTHH:mm:ss.fffZ |
|
Kuvert-ID
|
data.envelopeSummary.envelopeId | string | |
|
Kuvert skickat Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
åååå-MM-ddTHH:mm:ss.fffZ |
|
Kuvertstatus
|
data.envelopeSummary.status | string | |
|
E-postämne
|
data.envelopeSummary.emailSubject | string | |
|
kuvertDokument
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
Dokument-ID
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
Dokument-GUID
|
data.envelopeSummary.envelopeDocuments.documentGuid | string | |
|
Dokumentnamn
|
data.envelopeSummary.envelopeDocuments.documentName | string | |
|
Avsändarens namn
|
data.envelopeSummary.sender.userName | string | |
|
Avsändarens användar-ID
|
data.envelopeSummary.sender.userId | string | |
|
Avsändarens konto-ID
|
data.envelopeSummary.sender.accountId | string | |
|
Avsändarens e-postadress
|
data.envelopeSummary.sender.email | string | |
|
Undertecknarna
|
data.envelopeSummary.recipients.signers | array of object | |
|
Flikar
|
data.envelopeSummary.recipients.signers.tabs | object |
Nyckel/värde-par som representerar flikarna för den här mottagaren (där nyckeln är fältnamnet och värdet är fältvärdet). |
|
E-postmottagare
|
data.envelopeSummary.recipients.signers.email | string | |
|
Mottagarens ID
|
data.envelopeSummary.recipients.signers.recipientId | string | |
|
Routningsordning
|
data.envelopeSummary.recipients.signers.routingOrder | string | |
|
Mottagaren skickade Date-Time
|
data.envelopeSummary.recipients.signers.sentDateTime | date-time |
åååå-MM-ddTHH:mm:ss.fffZ |
|
Mottagarstatus
|
data.envelopeSummary.recipients.signers.status | string |
Mottagarens status. |
|
Mottagartyp
|
data.envelopeSummary.recipients.signers.recipientType | string |
Typ av mottagare. |
|
Verifieringstyp
|
data.envelopeSummary.recipients.signers.verificationType | string |
Typen av verifiering. |
|
Mottagarnamn
|
data.envelopeSummary.recipients.signers.name | string |
Namnet på mottagaren. |
WebhookEnvelopeResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Anpassade kuvertfält
|
customFields | object |
Nyckel/värde-par som representerar de anpassade fälten för det här kuvertet (där nyckeln är fältnamnet och värdet är fältvärdet). |
|
Kuvert skapat Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
åååå-MM-ddTHH:mm:ss.fffZ |
|
Avsändarens e-postadress
|
DocuSignEnvelopeInformation.EnvelopeStatus.Email | string | |
|
Kuvert-ID
|
DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID | string | |
|
Avsändarens IP-adress
|
DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress | string | |
|
Kuvert skickat Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Sent | date-time |
åååå-MM-ddTHH:mm:ss.fffZ |
|
Kuvertstatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
Ämne
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
Avsändarens namn
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
RecipientStatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
Flikar
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
Nyckel/värde-par som representerar flikarna för den här mottagaren (där nyckeln är fältnamnet och värdet är fältvärdet). |
|
Avslagsorsak
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
E-postmottagare
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email | string | |
|
Mottagarens ID
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId | string | |
|
Routningsordning
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder | string | |
|
Mottagaren skickade Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent | date-time |
åååå-MM-ddTHH:mm:ss.fffZ |
|
Mottagarstatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
Mottagarens status. |
|
Mottagartyp
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type | string |
Typ av mottagare. |
|
Mottagarnamn
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName | string |
Namnet på mottagaren. |
|
Tidszon
|
DocuSignEnvelopeInformation.TimeZone | string | |
|
Tidszonsförskjutning
|
DocuSignEnvelopeInformation.TimeZoneOffset | string |
GetDocumentsResponse
- Filinnehåll
- binary
AddRemindersResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Påminnelse aktiverad
|
reminderEnabled | string |
Påminnelse aktiverad |
FilteredEnvelopes
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Titel
|
title | string |
Kuvertets rubrik |
|
Description
|
description | string |
Beskrivning av kuvertaktiviteten |
|
Kuvert-ID
|
envelopeId | string |
Kuvert-ID |
|
Documents
|
documents | string |
Lista över dokumentnamn |
|
Mottagarnamn
|
recipients | string |
Lista över mottagarnamn |
|
Avsändarens namn
|
sender | string |
Avsändarens namn |
|
Läge
|
status | string |
Kuvertets status |
|
Statusdatum
|
statusDate | string |
Senaste statusuppdatering för aktiviteten |
|
Skickat datum
|
dateSent | date-time |
Kuvert skickat datum |
|
URL
|
url | string |
URL för kuvertet |
EmbeddedSenderResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Url för inbäddad avsändare
|
url | string |
Url:en för vyn inbäddad avsändare. |
EmbeddedSigningResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
URL
|
url | string |
URL:en för den inbäddade signeringsvyn. |
FilteredEnvelopeListResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Filtrerade kuvert
|
value | array of FilteredEnvelopes |
Filtrerade kuvert |
|
Fler kuvertresultat
|
hasMoreResults | boolean |
Visar om kuverten överskrider det angivna talet i fältet Returkuvert |
CreateEnvelopeResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kuvert-ID
|
envelopeId | string |
Kuvertets ID. |
|
Mall-ID
|
templateId | string |
Mallens ID. |
|
Läge
|
status | string |
Kuvertets status. |
|
Datumtid för status
|
statusDateTime | string |
Datetime som statusen angavs. |
|
URI
|
uri | string |
URI:n för kuvertet i DocuSign. |
ListRecipientsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kuvert-ID
|
envelopeId | string | |
|
Undertecknarna
|
signers | array of Signer |
Undertecknarna |
Tab
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Tabbnamn
|
name | string |
Namnet på fliken. |
|
Fliktyp
|
tabType | string |
Flikens typ. |
|
Fliketikett
|
tabLabel | string |
Flikens etikett. |
|
Tabbvärde
|
value | string |
Värdet för fliken. |
|
Flik-ID
|
tabId | string |
Flikens ID. |
|
Dokument-ID
|
documentId | string |
Dokumentets ID. |
|
Mottagarens ID
|
recipientId | string |
Mottagarens ID. |
|
Är förfyllnad
|
prefill | boolean |
Anger om fliken är av förfyllningstyp. |
|
Vald
|
selected | string |
Om flikar är kryssrutan anger du om fliken är markerad. |
RecipientTabsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Fliken Mottagare:
|
recipientTabs | array of Tab |
Fliken Mottagare |
Undertecknare
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Signeringsorder
|
routingOrder | string |
Mottagarens signeringsordning i dokumentet. |
|
Role
|
roleName | string |
Undertecknarens roll. |
|
Mottagarens ID
|
recipientId | string |
ID:t mottagaren. |
|
Namn
|
name | string |
Namnet på mottagaren. |
|
E-postmeddelande
|
string |
Mottagarens e-postadress. |
|
|
Mottagartyp
|
recipientType | string |
Skriv mottagaren. |
|
Verifieringstyp
|
verificationType | string |
Typen av verifiering. |
|
Mottagar-GUID
|
recipientIdGuid | string |
Mottagarens GUID. |
GetLoginAccountsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Inloggningskonton
|
loginAccounts | array of LoginAccount |
Inloggningskonton |
LoginAccount
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namn
|
name | string |
Namnet på kontot. |
|
Konto-ID-guid
|
accountIdGuid | string |
GUID för kontot. |
ListTabsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Flikar
|
tabs | array of Tab |
Flikar |
ListEnvelopeDocumentFieldsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Anpassat fält
|
envelopeDocumentFields | array of EnvelopeDocumentField |
Dokumentanpassade fält |
DocGenFormFieldsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Docgen-fält
|
docgenFields | array of DocGenFormField |
Docgen-fält |
DocGenFormField
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Dokument-ID
|
documentId | string |
Dokument-ID. |
|
Etikett
|
label | string |
Etikett. |
|
Typ
|
type | string |
Typ. |
|
Namn
|
name | string |
Namn. |
|
Värde
|
value | string |
Värde. |
ListTemplatesResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kuvertmallar
|
envelopeTemplates | array of EnvelopeTemplate |
Tillgängliga kuvertmallar. |
EnvelopeTemplate
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Mall-ID
|
templateId | string |
Mallens ID. |
|
Namn
|
name | string |
Namnet på mallen. |
BulkSendListGuid
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Guid för massutskickslista
|
listId | string |
Guid för massutskickslista |
EnvelopeCustomFieldResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Fält-ID
|
fieldId | string |
ID:t för det anpassade kuvertfältet. |
|
Fälttyp
|
fieldType | string |
Typ av anpassat kuvertfält. |
|
Namn
|
name | string |
Namnet på det anpassade kuvertfältet. |
|
Värde
|
value | string |
Värdet för det anpassade kuvertfältet. |
UpdateEnvelopeCustomFieldResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Fält-ID
|
fieldId | string |
ID:t för det anpassade kuvertfältet. |
|
Fälttyp
|
fieldType | string |
Typ av anpassat kuvertfält. |
|
Namn
|
name | string |
Namnet på det anpassade kuvertfältet. |
|
Värde
|
value | string |
Värdet för det anpassade kuvertfältet. |
ListDocumentsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kuvertdokument
|
envelopeDocuments | array of EnvelopeDocument |
De dokument som bifogas kuvertet. |
ListTemplateDocumentsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Malldokument
|
templateDocuments | array of EnvelopeDocument |
Dokument som är kopplade till en mall. |
AddDocumentsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Kuvert-ID
|
envelopeId | string |
Kuvertets ID. |
|
Kuvertdokument
|
envelopeDocuments | array of EnvelopeDocument |
De dokument som bifogas kuvertet. |
AddRecipientTabsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Flikar för mottagare
|
recipientTabs | array of RecipientTab |
Flikarna som har lagts till i en mottagare. |
EnvelopeDocument
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namn
|
name | string |
Namnet på dokumentet. |
|
Dokument-ID
|
documentId | string |
Dokumentets ID. |
|
Dokument-GUID
|
documentIdGuid | string |
Dokumentets guid. |
Mottagarflik
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Flik-ID
|
tabId | string |
Flikens ID. |
|
Fliktyp
|
tabType | string |
Flikens typ. |
EnvelopeDocumentField
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namn
|
name | string |
Namnet på det anpassade fältet. |
|
Värde
|
value | string |
Värdet för det anpassade fältet. |
DeclineReasonWithoutType
objekt
Detta är typen 'objekt'.