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 utom 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:      – Regioner i Azure Kina      - US Department of Defense (DoD)
Power Apps	Norm	Alla Power Apps-regioner utom följande:      - Amerikanska myndigheter (GCC High)      – China Cloud drivs av 21Vianet      - US Department of Defense (DoD)
Power Automate	Norm	Alla Power Automate-regioner utom 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 anvisningarna för att distribuera den här anslutningsappen som anpassad anslutningsapp i Microsoft Power Automate och Power Apps.

Gränser för begränsning

Namn	Samtal	Förnyelse period
API-anrop per anslutning	250	60 sekunder

Åtgärder

Copilot for Sales: Hämta e-postsammanfattning	Den här åtgärden hämtar ytterligare försäljningsinsikter som visas i e-postsammanfattningen för C4S i Outlook-sammanfattningen. Åtgärden förbättrar försäljningskopilotens befintliga färdigheter.
Copilot för försäljning: Hämta nyckelförsäljning	Den här åtgärden hämtar ytterligare försäljningsinsikter som visas i C4S-nyckelförsäljningsinformationskortet i Outlook-sidovagnen. Åtgärden förbättrar de befintliga färdigheterna hos copilot för försäljning
Copilot för försäljning: Lista kuvert	Copilot for Sales: Listkuvert returnerar information om Docusign-avtal som titel, dokument, mottagare, avtalsstatus, avsändarens namn och URL för avtalet. Plugin-programmet kan hantera begäranden som att visa mig alla mina avtal som jag behöver signera eller vad som är statusen för försäljningsorderkontraktet.
Copilot: Hämta relaterade aktiviteter	Den här åtgärden hämtar ytterligare försäljningsinsikter som är relaterade till en CRM-post som ska visas på sammanfattningskortet för C4S-posten. Åtgärden förbättrar försäljningskopilotens befintliga färdigheter.
Copilot: Hämta relaterade poster	Den här åtgärden hämtar poster som är relaterade till en CRM-post. Åtgärden förbättrar de befintliga färdigheterna i Copilot for Sales.
Copilot: 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.
Docusign MCP Server	Docusign MCP-servern ger möjlighet att skapa, checka in och hantera avtal under hela avtalslivscykeln.
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 från kuvertet	Hämta anpassad fältinformation från kuvertet
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 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	Hämta dokument från kuvert
INAKTUELL: Lägg till mottagare i ett kuvert	Lägg till mottagaren i ett kuvert.
INAKTUELL: Skapa kuvert med mall	Skapa ett nytt kuvert med en angiven mall.
INAKTUELL: Skapa kuvert med mall med mottagare	Skapa ett nytt kuvert med en angiven mall och ange mottagare.
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 kuvert	Lista mottagare från 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	Skapa ett nytt tomt kuvert.
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 Maestro-arbetsflöde	Starta Docusign Maestro-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.

Copilot for Sales: Hämta e-postsammanfattning

Åtgärds-ID:

scp-get-email-summary

Den här åtgärden hämtar ytterligare försäljningsinsikter som visas i e-postsammanfattningen för C4S i Outlook-sammanfattningen. Åtgärden förbättrar försäljningskopilotens befintliga färdigheter.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Posttyp	recordType		string	Den här indatan identifierar posttypen i CRM som är relaterad till det sammanfattade e-postmeddelandet.
Post-ID	recordId		string	Den här indatan ger den unika identifieraren för CRM-posten som är relaterad till det sammanfattade e-postmeddelandet.
CRM-typ	crmType		string	Den här indatan anger vilken typ av CRM som posten som är relaterad till det sammanfattade e-postmeddelandet finns i.
URL för CRM-organisation	crmOrgUrl		string	Den här indatan anger URL:en för CRM-miljön där posten som är relaterad till det sammanfattade e-postmeddelandet finns.
Kommaavgränsade e-postadresser	emailContacts	True	string	Den här inmatningen anger en lista över alla relevanta e-postmeddelanden för deltagare i den aktuella e-posttråden.
Främsta	top		integer	Denna indata anger antalet insikter som ska hämtas.
Hoppa över	skip		integer	Den här indatan anger hur många objekt som ska hoppa över när du hämtar insikter.

Returnerar

Body

EmailSummaryResponse

Copilot för försäljning: Hämta nyckelförsäljning

Åtgärds-ID:

scp-get-key-sales

Den här åtgärden hämtar ytterligare försäljningsinsikter som visas i C4S-nyckelförsäljningsinformationskortet i Outlook-sidovagnen. Åtgärden förbättrar de befintliga färdigheterna hos copilot för försäljning

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Posttyp	recordType	True	string	Den här inmatningen identifierar posttypen i CRM, för vilken viktig försäljningsinformation efterfrågas.
Post-ID	recordId	True	string	Den här indatan ger den unika identifieraren för den CRM-post för vilken viktig försäljningsinformation begärs.
Startdatum	startDateTime		date-time	Ange startdatumtid i formatet: 2017-05-02T01:44Z
Främsta	top		integer	Den här indatan anger antalet försäljningshöjdpunkter som ska hämtas.
Hoppa över	skip		integer	Den här indatan anger hur många objekt som ska hoppa över när du hämtar försäljningshöjdpunkter.
CRM-typ	crmType		string	Den här indatan anger vilken typ av CRM som CRM-posten finns i, för vilken viktig försäljningsinformation begärs.
URL för CRM-organisation	crmOrgUrl		string	Den här indatan anger URL:en för CRM-miljön där CRM-posten finns, för vilken viktig försäljningsinformation begärs.

Returnerar

Body

KeySalesResponse

Copilot för försäljning: Lista kuvert

Åtgärds-ID:

SalesCopilotListEnvelopes

Copilot for Sales: Listkuvert returnerar information om Docusign-avtal som titel, dokument, mottagare, avtalsstatus, avsändarens namn och URL för avtalet. Plugin-programmet kan hantera begäranden som att visa mig alla mina avtal som jag behöver signera eller vad som är statusen för försäljningsorderkontraktet.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Mottagarens namn	recipientName		string	Den här åtgärden visar kuvert baserat på mottagarens namn
Mottagarens emailId	recipientEmailId		string	Den här åtgärden visar kuvert baserat på mottagarens e-post-ID
Kuvertämne	envelopeTitle		string	Den här åtgärden visar kuvert baserat på kuvertets e-postä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	Den här åtgärden visar kuvert baserat på ett värde för dess anpassade fält
Kuvertstatus	envelopeStatus		string	Den här åtgärden visar kuvert baserat på kuvertets status
Mapp	folder_ids		string	Den här åtgärden visar kuvert baserat på olika tillstånd i kuvertet
Sortera efter	order_by		string	Den här åtgärden beställer kuvert baserat på specifik egenskap
Främsta	top		integer	De översta kuverten som ska returneras
Hoppa över	skip		integer	Kuvert som ska hoppas över
Startdatum	startDateTime		date-time	Ange startdatumtid i formatet: 2017-05-02T01:44Z
Slutdatum	endDateTime		date-time	Ange slutdatum i formatet: 2017-05-02T01:44Z

Returnerar

Body

FilteredSalesCopilotEnvelopeListResponse

Copilot: Hämta relaterade aktiviteter

Åtgärds-ID:

scp-get-related-activities

Den här åtgärden hämtar ytterligare försäljningsinsikter som är relaterade till en CRM-post som ska visas på sammanfattningskortet för C4S-posten. Åtgärden förbättrar försäljningskopilotens befintliga färdigheter.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Posttyp	recordType	True	string	Denna indata anger den entitets- eller objektstyp i CRM för vilka insikter begärs.
Post-ID	recordId	True	string	Denna indata indikerar den unika identifierare för den CRM-post för vilken insikter begärs.
Startdatum	startDateTime		date-time	Denna indata anger startdatum och starttid för de insikter som begärs.
Slutdatum	endDateTime		date-time	Denna indata anger slutdatum och sluttid för de insikter som begärs.
Främsta	top		integer	Denna indata anger antalet insikter som ska hämtas.
Hoppa över	skip		integer	Denna indata anger antalet insikter som ska hoppas över.
CRM-typ	crmType		string	Denna indata anger i vilken typ av CRM som den CRM-post finns för vilken insikter begärs.
URL för CRM-organisation	crmOrgUrl		string	Denna indata anger URL:en för den CRM-miljö i vilken CRM-posten finns för vilken insikter begärs.

Returnerar

Body

ActivityListResponseEnvelope

Copilot: Hämta relaterade poster

Åtgärds-ID:

scp-get-related-records

Den här åtgärden hämtar poster som är relaterade till en CRM-post. Åtgärden förbättrar de befintliga färdigheterna i Copilot for Sales.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Posttyp	recordType	True	string	Den här indatan identifierar posttypen i CRM som relaterade poster begärs för.
Post-ID	recordId	True	string	Den här indatan ger den unika identifieraren för CRM-posten som relaterade poster begärs för.
Startdatum	startDateTime		date-time	Ange startdatumtid i formatet: 2017-05-02T01:44Z
Främsta	top		integer	Den här indatan anger antalet relaterade poster som ska hämtas.
Hoppa över	skip		integer	Den här indatan anger antalet poster som ska hoppa över när relaterade poster hämtas.
CRM-typ	crmType		string	Den här indatan anger vilken typ av CRM som de relaterade posterna hämtas från.
URL för CRM-organisation	crmOrgUrl		string	Den här indatan anger URL:en för CRM-miljön som de relaterade posterna hämtas från.

Returnerar

Body

DocumentRecordListResponseEnvelope

Copilot: Lista kuvert

Åtgärds-ID:

ListEnvelopes

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

Namn	Nyckel	Krävs	Typ	Beskrivning
Mottagarens namn	recipientName		string	Den här åtgärden visar kuvert baserat på mottagarens namn
Mottagarens emailId	recipientEmailId		string	Den här åtgärden visar kuvert baserat på mottagarens e-post-ID
Kuvertämne	envelopeTitle		string	Den här åtgärden visar kuvert baserat på kuvertets e-postä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	Den här åtgärden visar kuvert baserat på ett värde för dess anpassade fält
Kuvertstatus	envelopeStatus		string	Den här åtgärden visar kuvert baserat på kuvertets status
Mapp	folder_ids		string	Den här åtgärden visar kuvert baserat på olika tillstånd i kuvertet
Sortera efter	order_by		string	Den här åtgärden beställer kuvert baserat på specifik egenskap
Främsta	top		integer	De översta kuverten som ska returneras
Hoppa över	skip		integer	Kuvert som ska hoppas över
Startdatum	from_date		date-time	Ange när inget värde anges av användaren. Ange startdatum i mönstret eller formatet: 2017-05-02T01:44Z.
Slutdatum	to_date		date-time	Ange när inget värde anges av användaren. Ange slutdatum i mönstret eller formatet: 2017-05-02T01:44Z.

Returnerar

Body

FilteredEnvelopeListResponse

Docusign MCP Server

Åtgärds-ID:

mcp_Docusign

Docusign MCP-servern ger möjlighet att skapa, checka in och hantera avtal under hela avtalslivscykeln.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
jsonrpc	jsonrpc		string
Id-nummer	id		string
method	method		string
params	params		object
resultat	result		object
fel	error		object
sessionId	sessionId		string

Returnerar

Body

MCPQueryResponse

Generera inbäddad signerings-URL (V2)

Åtgärds-ID:

GenerateEmbeddedSigningURLV2

Generera inbäddad signerings-URL (V2)

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	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.

Returnerar

Body

EmbeddedSigningResponse

Generera inbäddad signerings-URL [INAKTUELL]

Åtgärds-ID:

GenerateEmbeddedSigningURL

Generera inbäddad signerings-URL

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	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.

Returnerar

Body

EmbeddedSigningResponse

Generera url för inbäddad avsändare

Åtgärds-ID:

GenerateEmbeddedSenderURL

Generera url för inbäddad avsändare

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	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.

Returnerar

Body

EmbeddedSenderResponse

Hämta anpassad fältinformation från kuvertet

Åtgärds-ID:

GetEnvelopeCustomField

Hämta anpassad fältinformation från kuvertet

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Namn på anpassat fält	fieldName	True	string	Namn på anpassat fält

Returnerar

Body

EnvelopeCustomFieldResponse

Hämta dokument från ett kuvert

Åtgärds-ID:

GetDocumentsV2

Hämta dokument från ett kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Utdataformat	documentId	True	string	Ange ett specifikt dokument-ID eller använd ett utdataformat från listrutan

Returnerar

response

GetDocumentsResponse

Hämta dokumentanpassade fält från kuvert

Åtgärds-ID:

GetEnvelopeDocumentFields

Hämta dokumentanpassade fält från kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Dokument-ID	documentId	True	string	Dokument-ID

Returnerar

Body

ListEnvelopeDocumentFieldsResponse

Hämta dokumentflikar från kuvert

Åtgärds-ID:

GetEnvelopeDocumentTabs

Hämta dokumentflikar från kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Dokument-ID	documentId	True	string	Dokument-ID

Returnerar

Body

ListTabsResponse

Hämta dokumentflikar från mallen

Åtgärds-ID:

GetTemplateDocumentTabs

Hämta dokumentflikar från mallen

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Template	templateId	True	string	Mall-id
Dokument-ID	documentId	True	string	Dokument-ID

Returnerar

Body

ListTabsResponse

Hämta dokumentinformation från kuvertet

Åtgärds-ID:

GetEnvelopeDocumentInfo

Hämta dokumentinformation från kuvertet

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Dokumentnamn	documentName	True	string	Filnamn med filnamnstillägg

Returnerar

Body

EnvelopeDocument

Hämta formulärfält för dokumentgenerering från kuvert

Åtgärds-ID:

GetDocgenFormFields

Hämta formulärfält för dokumentgenerering från kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID

Returnerar

Body

DocGenFormFieldsResponse

Hämta granskningshändelselista

Åtgärds-ID:

GetAuditEvents

Hämta granskningshändelselista

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID

Returnerar

response

object

Hämta information för fliken Mottagare

Åtgärds-ID:

GetTabInfo

Returnerar värdet för fliken för den angivna mottagaren

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Mottagar-ID	recipientId	True	string	Mottagar-ID
Tabbetikett	tabLabel	True	string	Tabbetikett

Returnerar

Body

Tab

Hämta mottagarflikar från kuvert

Åtgärds-ID:

GetEnvelopeRecipientTabs

Hämta mottagarflikar från kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Mottagar-ID	recipientId	True	string	Mottagar-ID

Returnerar

Body

RecipientTabsResponse

Hämta mottagarinformation från kuvertet

Åtgärds-ID:

GetRecipientFields

Hämta mottagarinformation från kuvertet

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
E-postmottagare	recipientEmail		string	E-postmottagare
Riktnummer	areaCode		string	Mottagarens riktnummer
Telefonnummer	phoneNumber		string	Mottagarens telefonnummer
Mottagar-ID	recipientId		string	Recipinet-ID

Returnerar

Body

Signer

INAKTUELL: Hämta dokument från kuvert

Åtgärds-ID:

GetDocuments

Hämta dokument från kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	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.

Returnerar

response

GetDocumentsResponse

INAKTUELL: Lägg till mottagare i ett kuvert

Åtgärds-ID:

AddRecipientToEnvelope

Lägg till mottagaren i ett kuvert.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
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.

Returnerar

Body

ListRecipientsResponse

INAKTUELL: Skapa kuvert med mall

Åtgärds-ID:

CreateEnvelopeFromTemplate

Skapa ett nytt kuvert med en angiven mall.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Template	templateId	True	string	Mall-id
Kuvertstatus	status	True	string	Kuvertstatus
Anpassade fält	accountCustomFields	True	dynamic	Hämta de anpassade fälten som angetts på kontonivå.

Returnerar

Body

CreateEnvelopeResponse

INAKTUELL: Skapa kuvert med mall med mottagare

Åtgärds-ID:

SendEnvelope

Skapa ett nytt kuvert med en angiven mall och ange mottagare.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvertstatus	status	True	string	Kuvertstatus
Template	templateId	True	string	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

Returnerar

Body

CreateEnvelopeResponse

Lista kuvert

Åtgärds-ID:

SearchListEnvelopes

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

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	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
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.

Returnerar

Body

FilteredEnvelopeListResponse

Lista mallar

Åtgärds-ID:

GetEnvelopeTemplates

Lista mallar för ett specifikt konto.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID

Returnerar

Body

ListTemplatesResponse

Lista mottagare från kuvert

Åtgärds-ID:

GetRecipientStatus

Lista mottagare från kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Mapp	folderId	True	string	Mapp-ID
Kuvert	envelopeId	True	string	Kuvert-ID

Returnerar

Body

ListRecipientsResponse

Logga in

Åtgärds-ID:

GetLoginAccounts

Logga in

Returnerar

Body

GetLoginAccountsResponse

Lägga till dokument i ett kuvert

Åtgärds-ID:

AddDocumentsToEnvelope

Lägg till dokument i ett kuvert.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	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	Mottagar-ID

Returnerar

Body

AddDocumentsResponse

Lägga till flikar för en mottagare på ett kuvert

Åtgärds-ID:

AddRecipientTabs

Lägga till flikar för en mottagare på ett kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Recipient	recipientId	True	string	Mottagar-ID
Fliktyp	tabType	True	string	Fliktyp
flikinformation	tabDetails	True	dynamic	Information om den markerade fästpunktsfliken.

Returnerar

Body

AddRecipientTabsResponse

Lägga till mottagare i ett kuvert (V2)

Åtgärds-ID:

AddRecipientToEnvelopeV2

Lägg till mottagaren i ett kuvert.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
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		integer	För SMS-meddelanden, landskoden, utan inledande + tecken.
SMS-telefonnummer	phoneNumber		integer	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.

Returnerar

Body

Signer

Lägga till påminnelser för ett kuvert

Åtgärds-ID:

AddReminders

Lägga till påminnelser för ett kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	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.

Returnerar

Body

AddRemindersResponse

Lägga till verifieringstyp till en mottagare

Åtgärds-ID:

AddVerificationToRecipient

Lägg till verifieringstyp till en mottagare.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Mottagar-ID	recipientId	True	string	Mottagar-ID
Mottagartyp	recipientType	True	string	Mottagartyp
Verifieringstyp	verificationType	True	string	Verifieringstyp
Ytterligare mottagardata	additionalRecipientData		dynamic	Ytterligare mottagardata.

Massutskicka kuvert med mall

Åtgärds-ID:

BulkSend

Massutskicka kuvert med mall

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	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

Returnerar

Body

BulkSendListGuid

Ogiltigförklara kuvertet

Åtgärds-ID:

VoidEnvelope

Ogiltigt kuvertet.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Orsak till ogiltighet	voidedReason	True	string	Ogiltig orsak

Returnerar

response

object

Skapa kuvert

Åtgärds-ID:

CreateBlankEnvelope

Skapa ett nytt tomt kuvert.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	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.
Anpassade fält	accountCustomFields		dynamic	Hämta de anpassade fälten som angetts på kontonivå.

Returnerar

Body

CreateEnvelopeResponse

Skapa kuvert med hjälp av mall med mottagare och flikar

Åtgärds-ID:

SendEnvelopeWithRecipientFields

Skapa kuvert med hjälp av mall med mottagare och flikar

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Template	templateId	True	string	Mall-id
Mottagare	recipients		dynamic	Undertecknarna av dokumentet.
Ämne för e-post	emailSubject		string	Ämne för e-post

Returnerar

Body

CreateEnvelopeResponse

Skapa kuvert med mall

Åtgärds-ID:

CreateEnvelopeFromTemplateNoRecipients

Skapa ett nytt kuvert med en angiven mall.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Template	templateId	True	string	Mall-id
Kuvertstatus	status	True	string	Kuvertstatus

Returnerar

Body

CreateEnvelopeResponse

Skapa kuvert med sammansatta mallar

Åtgärds-ID:

CompositeTemplates

Skapa kuvert med sammansatta mallar

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	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
body	body		dynamic

Returnerar

Namn	Stig	Typ	Beskrivning
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

Åtgärds-ID:

CreateBulkSendList

Skapa masssändningslista

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Namn på masssändningslista	name	True	string	Namn på masssändningslista
CSV-fil	csv		string	Ladda upp CSV-fil

Returnerar

Body

BulkSendListGuid

Skicka kuvert

Åtgärds-ID:

SendDraftEnvelope

Skicka ett befintligt kuvert.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID

Returnerar

response

object

Skicka kuvertet igen

Åtgärds-ID:

ResendEnvelope

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

Namn	Nyckel	Krävs	Typ	Beskrivning
Kuvert	envelopeId	True	string	Kuvert-ID

Returnerar

response

object

Starta Docusign Maestro-arbetsflöde

Åtgärds-ID:

TriggerMaestroFlow

Starta Docusign Maestro-arbetsflöde

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	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å Maestro-arbetsflödesinstansen
variable	variable		dynamic

Returnerar

TriggerMaestroFlowResponse

response

object

Ta bort mottagaren från ett kuvert

Åtgärds-ID:

RemoveRecipientFromEnvelope

Ta bort mottagaren från ett kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Mapp	folderId	True	string	Mapp-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Recipient	RemoveRecipientFromEnvelopeRecipientId	True	string	Mottagar-ID

Returnerar

Body

ListRecipientsResponse

Tillämpa en mall på dokument

Åtgärds-ID:

ApplyTemplatesToDocuments

Tillämpa en mall på dokument

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert-ID	envelopeId	True	string	Kuvert-ID
Template	templateId	True	string	Template
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

Åtgärds-ID:

UpdateEnvelopeCustomField

Uppdatera värde för det angivna anpassade kuvertfältet

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	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

Returnerar

Body

UpdateEnvelopeCustomFieldResponse

Uppdatera formulärfält för dokumentgenerering från kuvert

Åtgärds-ID:

UpdateDocgenFormFields

Uppdatera formulärfält för dokumentgenerering från kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	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
: Tabellnamn	tableName		string	Krävs för "Tabellrad". Ange tabellnamnet.
: Tabellrad	rowNumber		string	Krävs för "Tabellrad". Ange radnumret

Uppdatera kuvertförfyllnadsflikar

Åtgärds-ID:

UpdateEnvelopePrefillTabs

Uppdatera värden för en lista med förfyllningsflikar

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Dokument-ID	documentId	True	string	Dokument-ID
Typ	tabType		string	Typ
Id	tabId		string	Id
Värde	value		string	Värde

Uppdatera mottagaren på ett kuvert

Åtgärds-ID:

UpdateEnvelopeRecipient

Uppdatera mottagaren på ett kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Mottagar-ID	recipientId	True	string	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		integer	För SMS-meddelanden, landskoden, utan inledande + tecken.
SMS-telefonnummer	phoneNumber		integer	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.

Returnerar

Body

Signer

Uppdatera tabbvärden för mottagare på ett kuvert

Åtgärds-ID:

UpdateRecipientTabsValues

Uppdatera tabbvärden för mottagare på ett kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID
Recipient	recipientId	True	string	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

Åtgärds-ID:

ListTemplateDocuments

Visa en lista över dokument från en mall

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Template	templateId	True	string	Mall-id

Returnerar

Body

ListTemplateDocumentsResponse

Visa en lista över dokument från ett kuvert

Åtgärds-ID:

ListEnvelopeDocuments

Visa en lista över dokument från ett kuvert

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Kuvert	envelopeId	True	string	Kuvert-ID

Returnerar

Body

ListDocumentsResponse

Visa versionsnummer (endast som referens. Inkludera inte i ett flöde för körning)

Åtgärds-ID:

BuildNumber

Identifierare för den distribuerade versionen.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Byggnummer	buildNumber		dynamic

Returnerar

response

object

Utlösare

INAKTUELL: När en kuvertstatus ändras (Anslut)	Utlöser ett nytt flöde när en kuvertstatus ändras.
INAKTUELL: När en kuvertstatus ändras (Anslut) (V2)	Utlöser ett nytt flöde när en kuvertstatus ändras.
När en kuvertstatus ändras (Anslut) (V3)	Utlöser ett nytt flöde när en kuvertstatus ändras.

INAKTUELL: När en kuvertstatus ändras (Anslut)

Åtgärds-ID:

CreateHookEnvelope

Utlöser ett nytt flöde när en kuvertstatus ändras.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Anslut namn	name	True	string
Kuverthändelse	envelopeEvents	True	string

Returnerar

Body

WebhookEnvelopeResponse

INAKTUELL: När en kuvertstatus ändras (Anslut) (V2)

Åtgärds-ID:

CreateHookEnvelopeV2

Utlöser ett nytt flöde när en kuvertstatus ändras.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Anslut namn	name	True	string
Kuverthändelse	envelopeEvents	True	string

Returnerar

Body

WebhookEnvelopeResponseV2

När en kuvertstatus ändras (Anslut) (V3)

Åtgärds-ID:

CreateHookEnvelopeV3

Utlöser ett nytt flöde när en kuvertstatus ändras.

Parametrar

Namn	Nyckel	Krävs	Typ	Beskrivning
Account	accountId	True	string	Konto-ID
Anslut namn	name	True	string
Kuverthändelse	envelopeEvents	True	string

Returnerar

Body

WebhookEnvelopeResponseV2

Definitioner

WebhookEnvelopeResponseV2

Namn	Stig	Typ	Beskrivning
Anpassade fä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
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
Mottagar-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

Namn	Stig	Typ	Beskrivning
Anpassade fä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
Mottagar-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

Namn	Stig	Typ	Beskrivning
Påminnelse aktiverad	reminderEnabled	string	Påminnelse aktiverad

FilteredEnvelopes

Namn	Stig	Typ	Beskrivning
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

SalesCopilotFilteredEnvelopes

Namn	Stig	Typ	Beskrivning
Titel	title	string	Kuvertets rubrik
Textremsa	subTitle	string	Underetikett för kuvertet
URL	url	string	URL för kuvertet
Ytterligare egenskaper	additionalPropertiesForSalesEnvelope.additionalPropertiesForSalesEnvelope	string	Ytterligare egenskaper

Activity

Namn	Stig	Typ	Beskrivning
Titel	title	string	Denna utdata anger rubriken för aktiviteten på hänvisningskortet.
Description	description	string	Denna utdata anger beskrivningen av insikten.
DateTime	dateTime	date-time	Det här utdata anger den tid som är associerad med insikten.
URL	url	string	Denna utdata visar URL:en för att öppna en insikt.
Ytterligare egenskaper	additionalProperties.additionalProperties	string	Ytterligare egenskaper för aktiviteten

E-postsumma

Namn	Stig	Typ	Beskrivning
Titel	Title	string	Det här utdata anger namnet på partneravsnittet och bör endast innehålla partnerns namn.
beskrivning	Description	string	Denna utdata anger texten som du vill ska tas med i e-postsammanfattningen.

KeySales

Namn	Stig	Typ	Beskrivning
Titel	Title	string	Det här resultatet anger titeln på referenskortet för insikten.
beskrivning	description	string	Resultatet indikerar texten av den insikt som ska ingå i den viktiga försäljningsinformationen.
Url för kuvertet	url	string	Den här utskriften visar URL:en för att lära dig mer om insikter.
Tid som är associerad med insikten	dateTime	string	Det här utdata anger den tid som är associerad med insikten.
Ytterligare egenskaper	additionalProperties.additionalProperties	string	Dessa utdata anger ytterligare egenskaper som namn/värde-par för varje relaterad insikt som returneras av åtgärden.

DocumentRecord

Namn	Stig	Typ	Beskrivning
Post-ID	recordId	string	Utdata identifierar unikt varje relaterad post som returneras av åtgärden.
Visningsnamn för posttyp	recordTypeDisplayName	string	Det här utdata anger visningsnamnet för posttypen för varje relaterad post som returneras av åtgärden.
Visningsnamn för posttyp i plural	recordTypePluralDisplayName	string	Det här utdata anger pluralvisningsnamnet för posttypen för varje relaterad post som returneras av åtgärden.
Posttyp	recordType	string	Det här utdata anger typen av varje relaterad post som returneras av åtgärden.
Posttitel	recordTitle	string	Det här utdata anger rubriken för varje relaterad post som returneras av åtgärden.
Url för kuvertet	url	string	Det här utdata anger URL:en för varje relaterad post som returneras av åtgärden.
Ytterligare egenskaper	additionalProperties.additionalProperties	string	Det här utdata anger ytterligare egenskaper som namn/värde-par för varje relaterad post som returneras av åtgärden.

EmbeddedSenderResponse

Namn	Stig	Typ	Beskrivning
Url för inbäddad avsändare	url	string	Url:en för vyn inbäddad avsändare.

EmbeddedSigningResponse

Namn	Stig	Typ	Beskrivning
URL	url	string	URL:en för den inbäddade signeringsvyn.

FilteredEnvelopeListResponse

Namn	Stig	Typ	Beskrivning
Filtrerade kuvert	value	array of FilteredEnvelopes	Filtrerade kuvert
Fler kuvertresultat	hasMoreResults	boolean	Visar om kuverten överskrider det angivna talet i fältet Returkuvert

FilteredSalesCopilotEnvelopeListResponse

Namn	Stig	Typ	Beskrivning
Filtrerade kuvert	value	array of SalesCopilotFilteredEnvelopes	Filtrerade kuvert
hasMoreResults	hasMoreResults	boolean

ActivityListResponseEnvelope

Namn	Stig	Typ	Beskrivning
Relaterade aktiviteter	value	array of Activity	Relaterade aktiviteter
hasMoreResults	hasMoreResults	boolean

EmailSummaryResponse

Namn	Stig	Typ	Beskrivning
E-postsammanfattning	value	array of EmailSummary	Nyckelförsäljning
hasMoreResults	hasMoreResults	boolean

KeySalesResponse

Namn	Stig	Typ	Beskrivning
Nyckelförsäljning"	value	array of KeySales	Nyckelförsäljning
hasMoreResults	hasMoreResults	boolean

DocumentRecordListResponseEnvelope

Namn	Stig	Typ	Beskrivning
Relaterade poster	value	array of DocumentRecord	Relaterade poster
hasMoreResults	hasMoreResults	boolean

CreateEnvelopeResponse

Namn	Stig	Typ	Beskrivning
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

Namn	Stig	Typ	Beskrivning
Undertecknarna	signers	array of Signer	Undertecknarna

Tab

Namn	Stig	Typ	Beskrivning
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.
Mottagar-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

Namn	Stig	Typ	Beskrivning
Fliken Mottagare:	recipientTabs	array of Tab	Fliken Mottagare

Undertecknare

Namn	Stig	Typ	Beskrivning
Signeringsorder	routingOrder	string	Mottagarens signeringsordning i dokumentet.
Role	roleName	string	Undertecknarens roll.
Mottagar-ID	recipientId	string	ID:t mottagaren.
Namn	name	string	Namnet på mottagaren.
E-postmeddelande	email	string	Mottagarens e-postadress.
Mottagartyp	recipientType	string	Skriv mottagaren.
Verifieringstyp	verificationType	string	Typen av verifiering.
Mottagar-GUID	recipientIdGuid	string	Mottagarens Guid.

GetLoginAccountsResponse

Namn	Stig	Typ	Beskrivning
Inloggningskonton	loginAccounts	array of LoginAccount	Inloggningskonton

LoginAccount

Namn	Stig	Typ	Beskrivning
Namn	name	string	Namnet på kontot.
Konto-ID-guid	accountIdGuid	string	GUID för kontot.

ListTabsResponse

Namn	Stig	Typ	Beskrivning
Flikar	tabs	array of Tab	Flikar

ListEnvelopeDocumentFieldsResponse

Namn	Stig	Typ	Beskrivning
Anpassat fält	envelopeDocumentFields	array of EnvelopeDocumentField	Dokumentanpassade fält

DocGenFormFieldsResponse

Namn	Stig	Typ	Beskrivning
Docgen-fält	docgenFields	array of DocGenFormField	Docgen-fält

DocGenFormField

Namn	Stig	Typ	Beskrivning
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

Namn	Stig	Typ	Beskrivning
Kuvertmallar	envelopeTemplates	array of EnvelopeTemplate	Tillgängliga kuvertmallar.

EnvelopeTemplate

Namn	Stig	Typ	Beskrivning
Mall-ID	templateId	string	Mallens ID.
Namn	name	string	Namnet på mallen.

BulkSendListGuid

Namn	Stig	Typ	Beskrivning
Guid för massutskickslista	listId	string	Guid för massutskickslista

EnvelopeCustomFieldResponse

Namn	Stig	Typ	Beskrivning
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

Namn	Stig	Typ	Beskrivning
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

Namn	Stig	Typ	Beskrivning
Kuvertdokument	envelopeDocuments	array of EnvelopeDocument	De dokument som bifogas kuvertet.

ListTemplateDocumentsResponse

Namn	Stig	Typ	Beskrivning
Malldokument	templateDocuments	array of EnvelopeDocument	Dokument som är kopplade till en mall.

AddDocumentsResponse

Namn	Stig	Typ	Beskrivning
Kuvert-ID	envelopeId	string	Kuvertets ID.
Kuvertdokument	envelopeDocuments	array of EnvelopeDocument	De dokument som bifogas kuvertet.

AddRecipientTabsResponse

Namn	Stig	Typ	Beskrivning
Flikar för mottagare	recipientTabs	array of RecipientTab	Flikarna som har lagts till i en mottagare.

EnvelopeDocument

Namn	Stig	Typ	Beskrivning
Namn	name	string	Namnet på dokumentet.
Dokument-ID	documentId	string	Dokumentets ID.
Dokument-GUID	documentIdGuid	string	Dokumentets guid.

Mottagarflik

Namn	Stig	Typ	Beskrivning
Flik-ID	tabId	string	Flikens ID.
Fliktyp	tabType	string	Flikens typ.

EnvelopeDocumentField

Namn	Stig	Typ	Beskrivning
Namn	name	string	Namnet på det anpassade fältet.
Värde	value	string	Värdet för det anpassade fältet.

DeclineReasonWithoutType

Avslagsorsak

MCPQueryResponse

Namn	Stig	Typ	Beskrivning
jsonrpc	jsonrpc	string
Id-nummer	id	string
method	method	string
params	params	object
resultat	result	object
fel	error	object

objekt

Detta är typen 'objekt'.

Använda den här kontakten

• Effektivisera processer för dokumentsignering och ombordstigning