Docusign

O Docusign permite que as organizações criem, se comprometam e gerenciem seus contratos em todo o ciclo de vida do contrato. Os clientes podem acelerar a receita, reduzir os riscos e desbloquear valor dos contratos que gerem os seus negócios.

Este conector está disponível nos seguintes produtos e regiões:

Serviço	Class	Regiões
Estúdio Copiloto	Standard	Todas as regiões do Power Automatic , exceto as seguintes: - China Cloud operado pela 21Vianet
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure China - Departamento de Defesa dos EUA (DoD)
Aplicações Power	Standard	Todas as regiões do Power Apps , exceto as seguintes: - China Cloud operado pela 21Vianet
Automatize o poder	Standard	Todas as regiões do Power Automatic , exceto as seguintes: - China Cloud operado pela 21Vianet

Contato
Nome	DocuSign
URL	https://support.docusign.com

Metadados do conector
Editora	DocuSign, Inc.
Sítio Web	https://www.docusign.com
Política de privacidade	https://www.docusign.com/company/privacy-policy
Categorias	Conteúdos e Ficheiros; Produtividade

Title

O DocuSign ajuda as organizações a se conectarem e automatizarem a forma como preparam, assinam, agem e gerenciam contratos. O conector DocuSign Demo se conecta apenas aos ambientes DocuSign Demo, mas oferece a mesma funcionalidade que o conector DocuSign normal. Quaisquer documentos em um ambiente de demonstração do DocuSign não são juridicamente vinculativos. Para todos os usos não demonstrativos, use o conector DocuSign regular.

Pré-requisitos

Para usar o gatilho Connect nessa integração, o DocuSign Connect deve estar habilitado na sua conta DocuSign. Ele não está habilitado por padrão. Uma vez ativada, a página Configurações do Connect pode ser acessada no aplicativo da Web DocuSign Admin. Usar o gatilho Connect nesta integração registrará automaticamente o webhook para você.

Obtenção de credenciais

Para experimentar o conector, use uma conta DEMO:

Ir para https://developers.docusign.com/
Crie uma conta Sandbox.

Estes são diferentes dos testes gratuitos na medida em que nunca expiram, têm 90% das nossas funcionalidades de conta paga e nenhum dos documentos enviados através do DEMO são juridicamente vinculativos ((https://support.docusign.com/en/articles/Free-account-vs-Developer-account).

Documentação do conector

Para obter documentação detalhada em torno do conector, consulte https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate

Problemas conhecidos e limitações

Para problemas com DocuSign por favor tente este link primeiro: https://support.docusign.com/en/articles/How-Do-I-Open-a-Case-in-the-DocuSign-Support-Center.

Instruções de implantação

Use estas instruções para implantar esse conector como conector personalizado no Microsoft Power Automate e Power Apps.

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	250	60 segundos

Ações

Adicionar destinatário a um envelope (V2)	Adicionar destinatário a um envelope.
Adicionar documentos a um envelope	Adicione documentos a um envelope.
Adicionar lembretes para um envelope	Adicionar lembretes para um envelope
Adicionar separadores para um destinatário num envelope	Adicionar separadores para um destinatário num envelope
Adicionar tipo de verificação a um destinatário	Adicione o tipo de verificação a um destinatário.
Anular o envelope	Anule o envelope.
Aplicar um modelo a documentos	Aplicar um modelo a documentos
Atualizar campo personalizado do envelope	Valor de atualização para o campo personalizado de envelope especificado
Atualizar campos de formulário de geração de documentos a partir do envelope	Atualizar campos de formulário de geração de documentos a partir do envelope
Atualizar destinatário em um envelope	Atualizar destinatário em um envelope
Atualizar guias de pré-preenchimento de envelope	Atualizar valores para uma lista de separadores de pré-preenchimento
Atualizar valores de tabulação do destinatário em um envelope	Atualizar valores de tabulação do destinatário em um envelope
Copilot: Obter registros relacionados	Essa ação obtém registros relacionados a um registro CRM. A ação reforça as competências já existentes do Copiloto de Vendas.
Copiloto de Vendas: Obtenha vendas-chave	Esta ação obtém informações adicionais de vendas que serão mostradas no cartão de informações principais de vendas do C4S no sidecar do Outlook. A ação reforça as competências existentes do copiloto para vendas
Copiloto para Vendas: Listar envelopes	Copiloto para Vendas: Os envelopes de lista retornam informações sobre os contratos Docusign, como título, documentos, destinatários, status do contrato, nome do remetente e URL do contrato. O plugin pode lidar com solicitações como mostrar-me todos os meus contratos que eu preciso assinar ou qual é o status do contrato de ordem de venda.
Copiloto para Vendas: Obter resumo por e-mail	Esta ação obtém informações de vendas adicionais que serão mostradas na experiência de resumo de e-mails do C4S dentro do resumo do Outlook. A ação reforça as competências existentes do copiloto para vendas.
Copiloto: Listar envelopes	Esta ação traz de volta envelopes Docusign relevantes com base no status do envelope, intervalo de datas, nome do destinatário, endereço de e-mail do destinatário, título do envelope, nome do documento ou valor do campo personalizado do envelope. A saída é o título, a descrição, o ID do envelope, os nomes dos documentos, os nomes dos remetentes, o status do envelope, a data de status, a data de envio e uma URL do envelope que pode ser usada como um link para visualizar o envelope no Docusign.
Copiloto: Obtenha atividades relacionadas	Esta ação obtém informações de vendas adicionais relacionadas com um registo do CRM que serão mostradas no cartão de resumo do registo C4S. A ação reforça as competências existentes do copiloto para vendas.
Criar envelope	Crie um novo envelope em branco.
Criar envelope usando modelo	Crie um novo envelope usando um modelo especificado.
Criar envelope usando modelo com destinatários e guias	Criar envelope usando modelo com destinatários e guias
Criar envelope usando modelos compostos	Criar envelope usando modelos compostos
Criar lista de envio em massa	Criar lista de envio em massa
DEPRECATED: Criar envelope usando modelo com destinatários	Crie um novo envelope usando um modelo especificado e especifique os destinatários.
Enviar envelope	Envie um envelope existente.
Enviar envelope em massa usando o modelo	Enviar envelope em massa usando o modelo
Gerar URL de assinatura incorporada (V2)	Gerar URL de assinatura incorporada (V2)
Gerar URL de assinatura incorporado [DEPRECATED]	Gerar URL de assinatura incorporada
Gerar URL de remetente incorporado	Gerar URL de remetente incorporado
Iniciar o fluxo de trabalho do Docusign Maestro	Iniciar o fluxo de trabalho do Docusign Maestro
Iniciar sessão	Iniciar sessão
Listar destinatários do envelope	Listar destinatários do envelope
Listar documentos de um envelope	Listar documentos de um envelope
Listar documentos de um modelo	Listar documentos de um modelo
Listar envelopes	Esta ação traz de volta envelopes Docusign relevantes com base no status do envelope, intervalo de datas, nome do destinatário, endereço de e-mail do destinatário, título do envelope, nome do documento ou valor do campo personalizado do envelope. A saída é o título, a descrição, o ID do envelope, os nomes dos documentos, os nomes dos remetentes, o status do envelope, a data de status, a data de envio e uma URL do envelope que pode ser usada como um link para visualizar o envelope no Docusign.
Modelos de lista	Listar modelos para uma conta específica.
Mostrar número de compilação (Apenas para referência. Não incluir em um fluxo para execução)	Identificador para a compilação implantada no momento.
Obter campos de formulário de geração de documentos a partir do envelope	Obter campos de formulário de geração de documentos a partir do envelope
Obter campos personalizados do documento a partir do envelope	Obter campos personalizados do documento a partir do envelope
Obter documentos de um envelope	Obter documentos de um envelope
Obter informações de campo personalizadas do envelope	Obter informações de campo personalizadas do envelope
Obter informações do destinatário do envelope	Obter informações do destinatário do envelope
Obter informações do documento a partir do envelope	Obter informações do documento a partir do envelope
Obter informações para a guia do destinatário	Devolve o valor do separador para um determinado destinatário
Obter lista de eventos de auditoria	Obter lista de eventos de auditoria
Obter separadores de destinatários a partir do envelope	Obter separadores de destinatários a partir do envelope
Obter separadores de documentos a partir do envelope	Obter separadores de documentos a partir do envelope
Obter separadores de documentos a partir do modelo	Obter separadores de documentos a partir do modelo
PRETERIDO: Adicionar destinatário a um envelope	Adicionar destinatário a um envelope.
PRETERIDO: Criar envelope usando modelo	Crie um novo envelope usando um modelo especificado.
PRETERIDO: Obter documentos do envelope	Obter documentos do envelope
Reenviar o envelope	Esta ação reenvia um envelope Docusign ou envia um lembrete aos destinatários que precisam assinar um contrato Docusign com base em um EnvelopeId fornecido.
Remover destinatário de um envelope	Remover destinatário de um envelope

Adicionar destinatário a um envelope (V2)

ID da Operação:: AddRecipientToEnvelopeV2

Adicionar destinatário a um envelope.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Tipo de destinatário	recipientType	True	string	Tipo de destinatário
ID de usuário do cliente	clientUserId		string	ID de usuário do cliente para signatário incorporado
URL de início do destinatário incorporado	embeddedRecipientStartURL		string	Uma cadeia de caracteres de URL fornecida pelo remetente para redirecionar um destinatário incorporado.
Ordem de assinatura	routingOrder		string	A ordem de assinatura do destinatário.
Idioma da notificação por e-mail	emailNotificationLanguage		string	Idioma da notificação por e-mail.
Assunto da notificação por e-mail	emailNotificationSubject		string	Assunto da notificação por e-mail.
Corpo de notificação por e-mail	emailNotificationBody		string	Corpo da notificação por e-mail.
Observação	note		string	Nota personalizada para o destinatário.
Nome da função	roleName		string	Nome da função associado ao destinatário.
SMS Indicativo do país	countryCode		integer	Para notificações por SMS, o código do país, sem sinal + à esquerda.
Número de telefone SMS	phoneNumber		integer	E-mail do signatário ou telefone SMS necessário. Exclua o indicativo do país para o número de telefone.
Grupo de Assinatura	signingGroupId		string	Grupo de Assinatura
Tipo de assinatura	signatureType		string	Tipos de assinatura baseada em padrões (SBS) DocuSign.
Fluxo de trabalho de verificação	workflowId		string	Os fluxos de trabalho de IDV com tipos de assinatura por caneta devem ser selecionados aqui.
Detalhes do tipo de destinatário selecionado	additionalRecipientParams		dynamic	Detalhes do tipo de destinatário selecionado.

Devoluções

Body: Signer

Adicionar documentos a um envelope

ID da Operação:: AddDocumentsToEnvelope

Adicione documentos a um envelope.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Base de documentos64 *	documentBase64	True	string	Base64 do conteúdo do documento
Tipo de documento *	fileExtension	True	string	pdf, docx etc.
Nome do documento *	name	True	string	Nome do documento
Transformar campos pdf	transformPdfFields		string	Falso
Atribuir separadores ao destinatário	assignTabsToRecipientId		string	ID do destinatário

Devoluções

Body: AddDocumentsResponse

Adicionar lembretes para um envelope

ID da Operação:: AddReminders

Adicionar lembretes para um envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Lembrete ativado	reminderEnabled	True	boolean	Quando definido como falso, os lembretes são desativados. O padrão é false
Atraso de lembrete	reminderDelay	True	string	Adicione o número de dias após os quais o destinatário recebe um e-mail de lembrete.
Frequência do lembrete	reminderFrequency	True	string	Adicione o número de dias entre os e-mails de lembrete.
Expirar após	expireAfter		string	Adicione o número de dias antes do prazo de validade.

Devoluções

Body: AddRemindersResponse

Adicionar separadores para um destinatário num envelope

ID da Operação:: AddRecipientTabs

Adicionar separadores para um destinatário num envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Recipient	recipientId	True	string	ID do destinatário
Tipo de tabulação	tabType	True	string	Tipo de tabulação
Detalhes da guia	tabDetails	True	dynamic	Os detalhes da guia âncora selecionada.

Devoluções

Body: AddRecipientTabsResponse

Adicionar tipo de verificação a um destinatário

ID da Operação:: AddVerificationToRecipient

Adicione o tipo de verificação a um destinatário.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
ID do destinatário	recipientId	True	string	ID do destinatário
Tipo de destinatário	recipientType	True	string	Tipo de destinatário
Tipo de verificação	verificationType	True	string	Tipo de verificação
Dados adicionais do destinatário	additionalRecipientData		dynamic	Dados adicionais do destinatário.

Anular o envelope

ID da Operação:: VoidEnvelope

Anule o envelope.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Motivo nulo	voidedReason	True	string	Motivo anulado

Devoluções

response: object

Aplicar um modelo a documentos

ID da Operação:: ApplyTemplatesToDocuments

Aplicar um modelo a documentos

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope ID	envelopeId	True	string	Envelope ID
Template	templateId	True	string	Template
Preservar destinatário do modelo	preserve_template_recipient		string	Falso
ID do documento	documentId	True	string	ID do documento
Página inicial do documento	documentStartPage	True	string	Página inicial do documento
Página final do documento	documentEndPage	True	string	Página final do documento

Atualizar campo personalizado do envelope

ID da Operação:: UpdateEnvelopeCustomField

Valor de atualização para o campo personalizado de envelope especificado

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
ID do campo	fieldId	True	string	ID de campo personalizado
Tipo de campo	fieldType	True	string	Tipo de campo personalizado
Nome	name	True	string	Nome do campo personalizado
Valor	value	True	string	Valor do campo personalizado

Devoluções

Body: UpdateEnvelopeCustomFieldResponse

Atualizar campos de formulário de geração de documentos a partir do envelope

ID da Operação:: UpdateDocgenFormFields

Atualizar campos de formulário de geração de documentos a partir do envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	Envelope ID
GUID do documento	documentGuid	True	string	GUID do documento
Tipo	fieldType		string	Escolha o tipo de campo de geração de documentos a ser atualizado
Nome	name		string	Insira o nome do campo ou da coluna da tabela
Valor	value		string	Insira os dados do campo
: Nome da tabela	tableName		string	Obrigatório para 'Linha da tabela'. Insira o nome da tabela.
: Linha da tabela	rowNumber		string	Obrigatório para 'Linha da tabela'. Insira o número da linha

Atualizar destinatário em um envelope

ID da Operação:: UpdateEnvelopeRecipient

Atualizar destinatário em um envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
ID do destinatário	recipientId	True	string	ID do destinatário
Tipo de assinatura	signatureType		string	Tipos de assinatura baseada em padrões (SBS) DocuSign.
Tipo de destinatário	recipientType	True	string	Tipo de destinatário
ID de usuário do cliente	clientUserId		string	ID de usuário do cliente para signatário incorporado
URL de início do destinatário incorporado	embeddedRecipientStartURL		string	Uma cadeia de caracteres de URL fornecida pelo remetente para redirecionar um destinatário incorporado.
Ordem de assinatura	routingOrder		string	A ordem de assinatura do destinatário.
Idioma da notificação por e-mail	emailNotificationLanguage		string	Idioma da notificação por e-mail.
Assunto da notificação por e-mail	emailNotificationSubject		string	Assunto da notificação por e-mail.
Corpo de notificação por e-mail	emailNotificationBody		string	Corpo da notificação por e-mail.
Observação	note		string	Nota personalizada para o destinatário.
Nome da função	roleName		string	Nome da função associado ao destinatário.
SMS Indicativo do país	countryCode		integer	Para notificações por SMS, o código do país, sem sinal + à esquerda.
Número de telefone SMS	phoneNumber		integer	E-mail do signatário ou telefone SMS necessário. Exclua o indicativo do país para o número de telefone.
Grupo de Assinatura	signingGroupId		string	Grupo de Assinatura
Detalhes do tipo de destinatário selecionado	additionalRecipientParams		dynamic	Detalhes do tipo de destinatário selecionado.

Devoluções

Body: Signer

Atualizar guias de pré-preenchimento de envelope

ID da Operação:: UpdateEnvelopePrefillTabs

Atualizar valores para uma lista de separadores de pré-preenchimento

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
ID do documento	documentId	True	string	ID do documento
Tipo	tabType		string	Tipo
Id	tabId		string	Id
Valor	value		string	Valor

Atualizar valores de tabulação do destinatário em um envelope

ID da Operação:: UpdateRecipientTabsValues

Atualizar valores de tabulação do destinatário em um envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Recipient	recipientId	True	string	ID do destinatário
Tipo	tabType		string	Tipo de tabulação
Id	tabId		string	Id
Valor	value		string	Valor

Copilot: Obter registros relacionados

ID da Operação:: scp-get-related-records

Essa ação obtém registros relacionados a um registro CRM. A ação reforça as competências já existentes do Copiloto de Vendas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Tipo de registo	recordType	True	string	Essa entrada identifica o tipo de registro no CRM para o qual os registros relacionados são solicitados.
ID do registo	recordId	True	string	Essa entrada fornece o identificador exclusivo do registro CRM para o qual os registros relacionados são solicitados.
Data de início	startDateTime		date-time	Insira a data-hora de início no formato: 2017-05-02T01:44Z
Início	top		integer	Essa entrada indica o número de registros relacionados a serem buscados.
Pular	skip		integer	Essa entrada indica o número de registros a serem ignorados ao buscar registros relacionados.
Tipo de CRM	crmType		string	Essa entrada indica o tipo de CRM do qual os registros relacionados são buscados.
URL da organização do CRM	crmOrgUrl		string	Essa entrada indica a URL do ambiente CRM do qual os registros relacionados são buscados.

Devoluções

Body: DocumentRecordListResponseEnvelope

Copiloto de Vendas: Obtenha vendas-chave

ID da Operação:: scp-get-key-sales

Esta ação obtém informações adicionais de vendas que serão mostradas no cartão de informações principais de vendas do C4S no sidecar do Outlook. A ação reforça as competências existentes do copiloto para vendas

Parâmetros

Name	Chave	Necessário	Tipo	Description
Tipo de registo	recordType	True	string	Essa entrada identifica o tipo de registro no CRM para o qual as principais informações de vendas são solicitadas.
ID do registo	recordId	True	string	Essa entrada fornece o identificador exclusivo do registro CRM para o qual as principais informações de vendas são solicitadas.
Data de início	startDateTime		date-time	Insira a data-hora de início no formato: 2017-05-02T01:44Z
Início	top		integer	Esta entrada indica o número de destaques de vendas a obter.
Pular	skip		integer	Essa entrada indica o número de itens a serem ignorados ao buscar destaques de vendas.
Tipo de CRM	crmType		string	Essa entrada indica o tipo de CRM no qual o registro CRM existe, para o qual as principais informações de vendas são solicitadas.
URL da organização do CRM	crmOrgUrl		string	Essa entrada indica a URL do ambiente do CRM no qual o registro do CRM existe, para o qual as principais informações de vendas são solicitadas.

Devoluções

Body: KeySalesResponse

Copiloto para Vendas: Listar envelopes

ID da Operação:: SalesCopilotListEnvelopes

Copiloto para Vendas: Os envelopes de lista retornam informações sobre os contratos Docusign, como título, documentos, destinatários, status do contrato, nome do remetente e URL do contrato. O plugin pode lidar com solicitações como mostrar-me todos os meus contratos que eu preciso assinar ou qual é o status do contrato de ordem de venda.

Parâmetros

Name	Chave	Tipo	Description
Nome do destinatário	recipientName	string	Esta ação lista envelopes com base no nome do destinatário
EmailId do destinatário	recipientEmailId	string	Esta ação lista envelopes com base no ID de e-mail do destinatário
Assunto do envelope	envelopeTitle	string	Esta ação lista os envelopes com base no assunto do e-mail do envelope
Nome do campo personalizado	customFieldName	string	Esta ação lista envelopes com base em um nome de seus campos personalizados
Valor do campo personalizado	customFieldValue	string	Esta ação lista envelopes com base em um valor de seus campos personalizados
Estado do envelope	envelopeStatus	string	Esta ação lista os envelopes com base no status do envelope
Folder	folder_ids	string	Esta ação lista envelopes com base em vários estados do envelope
Encomendar por	order_by	string	Esta ação ordena envelopes com base em propriedade específica
Início	top	integer	Envelopes superiores a devolver
Pular	skip	integer	Envelopes a serem ignorados
Data de início	startDateTime	date-time	Insira a data-hora de início no formato: 2017-05-02T01:44Z
Data de fim	endDateTime	date-time	Insira a data-hora de término no formato: 2017-05-02T01:44Z

Devoluções

Body: FilteredSalesCopilotEnvelopeListResponse

Copiloto para Vendas: Obter resumo por e-mail

ID da Operação:: scp-get-email-summary

Esta ação obtém informações de vendas adicionais que serão mostradas na experiência de resumo de e-mails do C4S dentro do resumo do Outlook. A ação reforça as competências existentes do copiloto para vendas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Tipo de registo	recordType		string	Essa entrada identifica o tipo de registro no CRM que está relacionado ao e-mail resumido.
ID do registo	recordId		string	Essa entrada fornece o identificador exclusivo do registro CRM que está relacionado ao e-mail resumido.
Tipo de CRM	crmType		string	Essa entrada indica o tipo de CRM no qual existe o registro relacionado ao e-mail resumido.
URL da organização do CRM	crmOrgUrl		string	Essa entrada indica a URL do ambiente CRM no qual existe o registro relacionado ao e-mail resumido.
Endereços de e-mail separados por vírgulas	emailContacts	True	string	Esta entrada indica uma lista de todos os e-mails de participantes relevantes no tópico de e-mail atual.
Início	top		integer	Esta entrada indica o número de informações a obter.
Pular	skip		integer	Essa entrada indica o número de itens a serem ignorados ao buscar insights.

Devoluções

Body: EmailSummaryResponse

Copiloto: Listar envelopes

ID da Operação:: ListEnvelopes

Esta ação traz de volta envelopes Docusign relevantes com base no status do envelope, intervalo de datas, nome do destinatário, endereço de e-mail do destinatário, título do envelope, nome do documento ou valor do campo personalizado do envelope. A saída é o título, a descrição, o ID do envelope, os nomes dos documentos, os nomes dos remetentes, o status do envelope, a data de status, a data de envio e uma URL do envelope que pode ser usada como um link para visualizar o envelope no Docusign.

Parâmetros

Name	Chave	Tipo	Description
Nome do destinatário	recipientName	string	Esta ação lista envelopes com base no nome do destinatário
EmailId do destinatário	recipientEmailId	string	Esta ação lista envelopes com base no ID de e-mail do destinatário
Assunto do envelope	envelopeTitle	string	Esta ação lista os envelopes com base no assunto do e-mail do envelope
Nome do campo personalizado	customFieldName	string	Esta ação lista envelopes com base em um nome de seus campos personalizados
Valor do campo personalizado	customFieldValue	string	Esta ação lista envelopes com base em um valor de seus campos personalizados
Estado do envelope	envelopeStatus	string	Esta ação lista os envelopes com base no status do envelope
Folder	folder_ids	string	Esta ação lista envelopes com base em vários estados do envelope
Encomendar por	order_by	string	Esta ação ordena envelopes com base em propriedade específica
Início	top	integer	Envelopes superiores a devolver
Pular	skip	integer	Envelopes a serem ignorados
Data de início	from_date	date-time	Digite '' quando nenhum valor for fornecido pelo usuário. Insira a data-hora de início no padrão ou formato: 2017-05-02T01:44Z.
Data de fim	to_date	date-time	Digite '' quando nenhum valor for fornecido pelo usuário. Insira a data-hora de término no padrão ou formato: 2017-05-02T01:44Z.

Devoluções

Body: FilteredEnvelopeListResponse

Copiloto: Obtenha atividades relacionadas

ID da Operação:: scp-get-related-activities

Esta ação obtém informações de vendas adicionais relacionadas com um registo do CRM que serão mostradas no cartão de resumo do registo C4S. A ação reforça as competências existentes do copiloto para vendas.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Tipo de registo	recordType	True	string	Esta entrada indica o tipo de objeto ou entidade na CRM para o qual são pedidas informações.
ID do registo	recordId	True	string	Esta entrada indica o identificador exclusivo do registo da CRM para o qual são pedidas as informações.
Data de início	startDateTime		date-time	Esta entrada indica a data e hora de início das informações pedidas.
Data de fim	endDateTime		date-time	Esta entrada indica a data e hora de fim das informações pedidas.
Início	top		integer	Esta entrada indica o número de informações a obter.
Pular	skip		integer	Esta entrada indica o número de informações a ignorar.
Tipo de CRM	crmType		string	Esta entrada indica o tipo de CRM no qual o registo da CRM existe, para o qual são pedidas as informações.
URL da organização do CRM	crmOrgUrl		string	Esta entrada indica o URL do ambiente da CRM no qual o registo da CRM existe, para o qual são pedidas as informações.

Devoluções

Body: ActivityListResponseEnvelope

Criar envelope

ID da Operação:: CreateBlankEnvelope

Crie um novo envelope em branco.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
assunto Email	emailSubject	True	string	Assunto do e-mail.
Corpo da mensagem de correio eletrónico	emailBody		string	Corpo do e-mail.
Campos personalizados	accountCustomFields		dynamic	Obtenha os campos personalizados definidos no nível da conta.

Devoluções

Body: CreateEnvelopeResponse

Criar envelope usando modelo

ID da Operação:: CreateEnvelopeFromTemplateNoRecipients

Crie um novo envelope usando um modelo especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Template	templateId	True	string	ID do modelo
Estado do envelope	status	True	string	Estado do envelope

Devoluções

Body: CreateEnvelopeResponse

Criar envelope usando modelo com destinatários e guias

ID da Operação:: SendEnvelopeWithRecipientFields

Criar envelope usando modelo com destinatários e guias

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Template	templateId	True	string	ID do modelo
Destinatários	recipients		dynamic	Os signatários do documento.
assunto Email	emailSubject		string	assunto Email

Devoluções

Body: CreateEnvelopeResponse

Criar envelope usando modelos compostos

ID da Operação:: CompositeTemplates

Criar envelope usando modelos compostos

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
assunto Email	emailSubject	True	string	Assunto do e-mail.
Corpo da mensagem de correio eletrónico	emailBody		string	Corpo do e-mail.
Estado do envelope	status	True	string	Estado do envelope
body	body		dynamic

Devoluções

Name	Caminho	Tipo	Description
Envelope Id	envelopeId	string	O id do envelope.
Situação	status	string	O status do envelope.
Data de status e hora	statusDateTime	string	A data/hora em que o status foi definido.
URI	uri	string	O URI do envelope no DocuSign.

Criar lista de envio em massa

ID da Operação:: CreateBulkSendList

Criar lista de envio em massa

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Nome da lista de envio em massa	name	True	string	Nome da lista de envio em massa
Arquivo CSV	csv		string	Carregar arquivo CSV

Devoluções

Body: BulkSendListGuid

DEPRECATED: Criar envelope usando modelo com destinatários

ID da Operação:: SendEnvelope

Crie um novo envelope usando um modelo especificado e especifique os destinatários.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Estado do envelope	status	True	string	Estado do envelope
Template	templateId	True	string	ID do modelo
Signatários	signers		dynamic	Os signatários do documento.
assunto Email	emailSubject		string	assunto Email
Corpo da mensagem de correio eletrónico	emailBody		string	Corpo da mensagem de correio eletrónico

Devoluções

Body: CreateEnvelopeResponse

Enviar envelope

ID da Operação:: SendDraftEnvelope

Envie um envelope existente.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope

Devoluções

response: object

Enviar envelope em massa usando o modelo

ID da Operação:: BulkSend

Enviar envelope em massa usando o modelo

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
GUID da lista de envio em massa	bulkSendListId	True	string	GUID da lista de envio em massa
ID do modelo	envelopeOrTemplateId	True	string	Insira o ID do modelo ou escolha um modelo na lista suspensa

Devoluções

Body: BulkSendListGuid

Gerar URL de assinatura incorporada (V2)

ID da Operação:: GenerateEmbeddedSigningURLV2

Gerar URL de assinatura incorporada (V2)

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	Envelope ID
Trata-se de um signatário presencial?	isInPersonSigner	True	string	Yes/No
Método de autenticação	authenticationMethod	True	string	Método de autenticação
URL de retorno	returnUrl	True	string	URL de retorno
URL adicional adicionado	additionalURL	True	dynamic	URL adicional adicionado.

Devoluções

Body: EmbeddedSigningResponse

Gerar URL de assinatura incorporado [DEPRECATED]

ID da Operação:: GenerateEmbeddedSigningURL

Gerar URL de assinatura incorporada

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	Envelope ID
Nome do signatário	signerName	True	string	Nome do signatário
E-mail do signatário	signerEmail	True	string	E-mail do signatário
ID de usuário do cliente	clientUserId		string	Obrigatório, a menos que o signatário seja presencial. Deixe em branco para os signatários presenciais
Método de autenticação	authenticationMethod	True	string	Método de autenticação
URL de retorno	returnUrl	True	string	URL de retorno
URL adicional adicionado	additionalURL		dynamic	URL adicional adicionado.

Devoluções

Body: EmbeddedSigningResponse

Gerar URL de remetente incorporado

ID da Operação:: GenerateEmbeddedSenderURL

Gerar URL de remetente incorporado

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Aberto em	openIn	True	string	Aberto em
URL de retorno	returnUrl	True	string	URL de retorno
URL adicional adicionado	additionalURL		dynamic	URL adicional adicionado.

Devoluções

Body: EmbeddedSenderResponse

Iniciar o fluxo de trabalho do Docusign Maestro

ID da Operação:: TriggerMaestroFlow

Iniciar o fluxo de trabalho do Docusign Maestro

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
fluxo de trabalho	workflowId	True	string	Insira o ID do fluxo de trabalho ou selecione o nome do fluxo de trabalho na lista suspensa
Nome da instância	instanceName	True	string	Nome da instância do fluxo de trabalho Maestro
variável	variable		dynamic

Devoluções

TriggerMaestroFlowResponse

response: object

Iniciar sessão

ID da Operação:: GetLoginAccounts

Iniciar sessão

Devoluções

Body: GetLoginAccountsResponse

Listar destinatários do envelope

ID da Operação:: GetRecipientStatus

Listar destinatários do envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Folder	folderId	True	string	ID da pasta
Envelope	envelopeId	True	string	ID do envelope

Devoluções

Body: ListRecipientsResponse

Listar documentos de um envelope

ID da Operação:: ListEnvelopeDocuments

Listar documentos de um envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope

Devoluções

Body: ListDocumentsResponse

Listar documentos de um modelo

ID da Operação:: ListTemplateDocuments

Listar documentos de um modelo

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Template	templateId	True	string	ID do modelo

Devoluções

Body: ListTemplateDocumentsResponse

Listar envelopes

ID da Operação:: SearchListEnvelopes

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Nome do destinatário	recipientName		string	Esta ação lista envelopes com base no nome do destinatário
E-mail do destinatário	recipientEmailId		string	Filtra envelopes por e-mail do destinatário
Assunto do envelope	envelopeTitle		string	Filtra envelopes por assunto do envelope
Nome do campo personalizado	customFieldName		string	Esta ação lista envelopes com base em um nome de seus campos personalizados
Valor do campo personalizado	customFieldValue		string	Filtros por valor de campo personalizado
Estado do envelope	envelopeStatus		string	Esta ação lista os envelopes com base no status do envelope
Folder	folder_ids		string	Filtra envelopes pela pasta selecionada
Encomendar por	order_by		string	Classifica os envelopes na ordem selecionada
Envelopes de devolução	top		integer	Especifique o número de envelopes a devolver (o padrão é 10; o máximo é 1.000)
Saltar envelopes	skip		integer	Especifique o número de envelopes a serem ignorados desde o início
Data de início	from_date		date-time	Insira a data-hora de início no formato UTC: 2017-05-02T01:44z
Data de fim	to_date		date-time	Insira a data-hora de término no formato UTC: 2017-05-02T01:44z.

Devoluções

Body: FilteredEnvelopeListResponse

Modelos de lista

ID da Operação:: GetEnvelopeTemplates

Listar modelos para uma conta específica.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta

Devoluções

Body: ListTemplatesResponse

Mostrar número de compilação (Apenas para referência. Não incluir em um fluxo para execução)

ID da Operação:: BuildNumber

Identificador para a compilação implantada no momento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Número de compilação	buildNumber		dynamic

Devoluções

response: object

Obter campos de formulário de geração de documentos a partir do envelope

ID da Operação:: GetDocgenFormFields

Obter campos de formulário de geração de documentos a partir do envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope

Devoluções

Body: DocGenFormFieldsResponse

Obter campos personalizados do documento a partir do envelope

ID da Operação:: GetEnvelopeDocumentFields

Obter campos personalizados do documento a partir do envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
ID do documento	documentId	True	string	ID do documento

Devoluções

Body: ListEnvelopeDocumentFieldsResponse

Obter documentos de um envelope

ID da Operação:: GetDocumentsV2

Obter documentos de um envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Formato de saída	documentId	True	string	Forneça um ID de documento específico ou use um formato de saída na lista suspensa

Devoluções

response: GetDocumentsResponse

Obter informações de campo personalizadas do envelope

ID da Operação:: GetEnvelopeCustomField

Obter informações de campo personalizadas do envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Nome do campo personalizado	fieldName	True	string	Nome do campo personalizado

Devoluções

Body: EnvelopeCustomFieldResponse

Obter informações do destinatário do envelope

ID da Operação:: GetRecipientFields

Obter informações do destinatário do envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
E-mail do destinatário	recipientEmail		string	E-mail do destinatário
Código de Área	areaCode		string	Código de área do destinatário
Número de Telefone	phoneNumber		string	Número de telefone do destinatário
ID do destinatário	recipientId		string	Recipinet Id

Devoluções

Body: Signer

Obter informações do documento a partir do envelope

ID da Operação:: GetEnvelopeDocumentInfo

Obter informações do documento a partir do envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Nome do documento	documentName	True	string	Nome do ficheiro com extensão

Devoluções

Body: EnvelopeDocument

Obter informações para a guia do destinatário

ID da Operação:: GetTabInfo

Devolve o valor do separador para um determinado destinatário

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
ID do destinatário	recipientId	True	string	ID do destinatário
Rótulo da guia	tabLabel	True	string	Rótulo da guia

Devoluções

Body: Tab

Obter lista de eventos de auditoria

ID da Operação:: GetAuditEvents

Obter lista de eventos de auditoria

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope

Devoluções

response: object

Obter separadores de destinatários a partir do envelope

ID da Operação:: GetEnvelopeRecipientTabs

Obter separadores de destinatários a partir do envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
ID do destinatário	recipientId	True	string	ID do destinatário

Devoluções

Body: RecipientTabsResponse

Obter separadores de documentos a partir do envelope

ID da Operação:: GetEnvelopeDocumentTabs

Obter separadores de documentos a partir do envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
ID do documento	documentId	True	string	ID do documento

Devoluções

Body: ListTabsResponse

Obter separadores de documentos a partir do modelo

ID da Operação:: GetTemplateDocumentTabs

Obter separadores de documentos a partir do modelo

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Template	templateId	True	string	ID do modelo
ID do documento	documentId	True	string	ID do documento

Devoluções

Body: ListTabsResponse

PRETERIDO: Adicionar destinatário a um envelope

ID da Operação:: AddRecipientToEnvelope

Adicionar destinatário a um envelope.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Nome do signatário	AddRecipientToEnvelopeName	True	string	O nome do destinatário.
E-mail do signatário	AddRecipientToEnvelopeEmail	True	string	O e-mail do destinatário.
Ordem de Assinatura	routingOrder		string	A ordem de assinatura do destinatário no documento.
Funções	roleName		string	O papel do signatário.

Devoluções

Body: ListRecipientsResponse

PRETERIDO: Criar envelope usando modelo

ID da Operação:: CreateEnvelopeFromTemplate

Crie um novo envelope usando um modelo especificado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Template	templateId	True	string	ID do modelo
Estado do envelope	status	True	string	Estado do envelope
Campos personalizados	accountCustomFields	True	dynamic	Obtenha os campos personalizados definidos no nível da conta.

Devoluções

Body: CreateEnvelopeResponse

PRETERIDO: Obter documentos do envelope

ID da Operação:: GetDocuments

Obter documentos do envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Envelope	envelopeId	True	string	ID do envelope
Certificado de conclusão	certificate	True	boolean	Quando definido como false, o certificado de assinatura de envelope é removido do download.

Devoluções

response: GetDocumentsResponse

Reenviar o envelope

ID da Operação:: ResendEnvelope

Esta ação reenvia um envelope Docusign ou envia um lembrete aos destinatários que precisam assinar um contrato Docusign com base em um EnvelopeId fornecido.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Envelope	envelopeId	True	string	ID do envelope

Devoluções

response: object

Remover destinatário de um envelope

ID da Operação:: RemoveRecipientFromEnvelope

Remover destinatário de um envelope

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Folder	folderId	True	string	ID da pasta
Envelope	envelopeId	True	string	ID do envelope
Recipient	RemoveRecipientFromEnvelopeRecipientId	True	string	ID do destinatário

Devoluções

Body: ListRecipientsResponse

Acionadores

DEPRECATED: Quando o status de um envelope muda (Connect) (V2)	Aciona um novo fluxo quando o status de um envelope é alterado.
PRETERIDO: Quando o status de um envelope muda (Conectar)	Aciona um novo fluxo quando o status de um envelope é alterado.
Quando o status de um envelope muda (Conectar) (V3)	Aciona um novo fluxo quando o status de um envelope é alterado.

DEPRECATED: Quando o status de um envelope muda (Connect) (V2)

ID da Operação:: CreateHookEnvelopeV2

Aciona um novo fluxo quando o status de um envelope é alterado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Nome da conexão	name	True	string
Evento do envelope	envelopeEvents	True	string

Devoluções

Body: WebhookEnvelopeResponseV2

PRETERIDO: Quando o status de um envelope muda (Conectar)

ID da Operação:: CreateHookEnvelope

Aciona um novo fluxo quando o status de um envelope é alterado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Nome da conexão	name	True	string
Evento do envelope	envelopeEvents	True	string

Devoluções

Body: WebhookEnvelopeResponse

Quando o status de um envelope muda (Conectar) (V3)

ID da Operação:: CreateHookEnvelopeV3

Aciona um novo fluxo quando o status de um envelope é alterado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Account	accountId	True	string	ID da conta
Nome da conexão	name	True	string
Evento do envelope	envelopeEvents	True	string

Devoluções

Body: WebhookEnvelopeResponseV2

Definições

WebhookEnvelopeResponseV2

Name	Caminho	Tipo	Description
Campos personalizados	data.envelopeSummary.customFields	object	Pares chave-valor que representam os campos personalizados para este envelope (onde chave é o nome do campo e valor é o valor do campo).
Envelope criado Date-Time	data.envelopeSummary.createdDateTime	date-time	aaaa-MM-ddTHH:mm:ss.fffZ
Envelope ID	data.envelopeSummary.envelopeId	string
Envelope enviado Date-Time	data.envelopeSummary.sentDateTime	date-time	aaaa-MM-ddTHH:mm:ss.fffZ
Estado do envelope	data.envelopeSummary.status	string
Assunto do e-mail	data.envelopeSummary.emailSubject	string
Nome do remetente	data.envelopeSummary.sender.userName	string
ID de utilizador do remetente	data.envelopeSummary.sender.userId	string
ID da conta do remetente	data.envelopeSummary.sender.accountId	string
Endereço de e-mail do remetente	data.envelopeSummary.sender.email	string
signatários	data.envelopeSummary.recipients.signers	array of object
Separadores	data.envelopeSummary.recipients.signers.tabs	object	Pares chave-valor que representam as guias desse destinatário (onde chave é o nome do campo e valor é o valor do campo).
E-mail do destinatário	data.envelopeSummary.recipients.signers.email	string
ID do destinatário	data.envelopeSummary.recipients.signers.recipientId	string
Ordem de roteamento	data.envelopeSummary.recipients.signers.routingOrder	string
Destinatário enviado Date-Time	data.envelopeSummary.recipients.signers.sentDateTime	date-time	aaaa-MM-ddTHH:mm:ss.fffZ
Status do destinatário	data.envelopeSummary.recipients.signers.status	string	O estatuto do destinatário.
Tipo de destinatário	data.envelopeSummary.recipients.signers.recipientType	string	O tipo de destinatário.
Tipo de verificação	data.envelopeSummary.recipients.signers.verificationType	string	O tipo de verificação.
Nome do destinatário	data.envelopeSummary.recipients.signers.name	string	O nome do destinatário.

WebhookEnvelopeResponse

Name	Caminho	Tipo	Description
Campos personalizados	customFields	object	Pares chave-valor que representam os campos personalizados para este envelope (onde chave é o nome do campo e valor é o valor do campo).
Envelope criado Date-Time	DocuSignEnvelopeInformation.EnvelopeStatus.Created	date-time	aaaa-MM-ddTHH:mm:ss.fffZ
Endereço de e-mail do remetente	DocuSignEnvelopeInformation.EnvelopeStatus.Email	string
Envelope ID	DocuSignEnvelopeInformation.EnvelopeStatus.EnvelopeID	string
Endereço IP do remetente	DocuSignEnvelopeInformation.EnvelopeStatus.SenderIPAddress	string
Envelope enviado Date-Time	DocuSignEnvelopeInformation.EnvelopeStatus.Sent	date-time	aaaa-MM-ddTHH:mm:ss.fffZ
Estado do envelope	DocuSignEnvelopeInformation.EnvelopeStatus.Status	string
Assunto	DocuSignEnvelopeInformation.EnvelopeStatus.Subject	string
Nome do remetente	DocuSignEnvelopeInformation.EnvelopeStatus.UserName	string
Status do destinatário	DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus	array of object
Separadores	DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs	object	Pares chave-valor que representam as guias desse destinatário (onde chave é o nome do campo e valor é o valor do campo).
Motivo de Recusa	DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason	DeclineReasonWithoutType
E-mail do destinatário	DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Email	string
ID do destinatário	DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RecipientId	string
Ordem de roteamento	DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.RoutingOrder	string
Destinatário enviado Date-Time	DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Sent	date-time	aaaa-MM-ddTHH:mm:ss.fffZ
Status do destinatário	DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status	string	O estatuto do destinatário.
Tipo de destinatário	DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Type	string	O tipo de destinatário.
Nome do destinatário	DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.UserName	string	O nome do destinatário.
Fuso Horário	DocuSignEnvelopeInformation.TimeZone	string
Deslocamento de fuso horário	DocuSignEnvelopeInformation.TimeZoneOffset	string

GetDocumentsResponse

Conteúdo do Ficheiro: binary

AddRemindersResponse

Name	Caminho	Tipo	Description
Lembrete ativado	reminderEnabled	string	Lembrete ativado

Envelopes filtrados

Name	Caminho	Tipo	Description
Title	title	string	Título do envelope
Description	description	string	Descrição da atividade do envelope
Envelope ID	envelopeId	string	Envelope ID
Documents	documents	string	Lista de nomes de documentos
Nomes dos destinatários	recipients	string	Lista de nomes de destinatários
Nome do remetente	sender	string	Nome do remetente
Situação	status	string	Estado do envelope
Data de status	statusDate	string	Última atualização de status da atividade
Data de envio	dateSent	date-time	Data de envio do envelope
URL	url	string	URL do envelope

SalesCopilotFilteredEnvelopes

Name	Caminho	Tipo	Description
Title	title	string	Título do envelope
Subtítulo	subTitle	string	Subtítulo do envelope
URL	url	string	URL do envelope
Propriedades Adicionais	additionalPropertiesForSalesEnvelope.additionalPropertiesForSalesEnvelope	string	Propriedades Adicionais

Activity

Name	Caminho	Tipo	Description
Title	title	string	Esta saída indica o título da atividade no cartão de citações.
Description	description	string	Esta saída indica a descrição das informações.
DateTime	dateTime	date-time	Essa saída indica o tempo associado ao insight.
URL	url	string	Esta saída indica o URL para abrir informações.
Propriedades Adicionais	additionalProperties.additionalProperties	string	Propriedades adicionais da atividade

EmailSummary

Name	Caminho	Tipo	Description
Title	Title	string	Esta saída indica o título da seção de parceiro e deve incluir apenas o nome do parceiro.
descrição	Description	string	Esta saída indica o texto que pretende incluir no resumo do e-mail.

Vendas de chaves

Name	Caminho	Tipo	Description
Title	Title	string	Este resultado indica o título do cartão de citação para a perspetiva.
descrição	description	string	Essa saída indica o texto do insight a ser incluído nas principais informações de vendas.
URL do envelope	url	string	Este resultado indica a URL para obter mais informações sobre o insight.
Tempo associado ao insight	dateTime	string	Essa saída indica o tempo associado ao insight.
Propriedades Adicionais	additionalProperties.additionalProperties	string	Este resultado indica propriedades adicionais, apresentadas como pares nome-valor, de cada insight relacionado retornado pela ação.

DocumentRecord

Name	Caminho	Tipo	Description
ID do registo	recordId	string	Essa saída identifica exclusivamente cada registro relacionado retornado pela ação.
Nome de exibição do tipo de registro	recordTypeDisplayName	string	Essa saída indica o nome de exibição do tipo de registro de cada registro relacionado retornado pela ação.
Nome de exibição do tipo de registro no plural	recordTypePluralDisplayName	string	Essa saída indica o nome de exibição plural do tipo de registro de cada registro relacionado retornado pela ação.
Tipo de registo	recordType	string	Essa saída indica o tipo de cada registro relacionado retornado pela ação.
Título do registo	recordTitle	string	Essa saída indica o título de cada registro relacionado retornado pela ação.
URL do envelope	url	string	Essa saída indica a URL de cada registro relacionado retornado pela ação.
Propriedades Adicionais	additionalProperties.additionalProperties	string	Essa saída indica propriedades adicionais como pares nome-valor de cada registro relacionado retornado pela ação.

EmbeddedSenderResponse

Name	Caminho	Tipo	Description
URL do remetente incorporado	url	string	A url da visualização do remetente incorporado.

EmbeddedSigningResponse

Name	Caminho	Tipo	Description
URL	url	string	A url da vista de assinatura incorporada.

FilteredEnvelopeListResponse

Name	Caminho	Tipo	Description
Envelopes filtrados	value	array of FilteredEnvelopes	Envelopes filtrados
Mais resultados do envelope	hasMoreResults	boolean	Mostra se os envelopes excedem o número especificado no campo Envelopes de retorno

FilteredSalesCopilotEnvelopeListResponse

Name	Caminho	Tipo	Description
Envelopes filtrados	value	array of SalesCopilotFilteredEnvelopes	Envelopes filtrados
temMaisResultados	hasMoreResults	boolean

ActivityListResponseEnvelope

Name	Caminho	Tipo	Description
Atividades relacionadas	value	array of Activity	Atividades relacionadas
temMaisResultados	hasMoreResults	boolean

EmailSummaryResponse

Name	Caminho	Tipo	Description
Resumo do e-mail	value	array of EmailSummary	Principais Vendas
temMaisResultados	hasMoreResults	boolean

KeySalesResponse

Name	Caminho	Tipo	Description
Principais vendas»	value	array of KeySales	Principais Vendas
temMaisResultados	hasMoreResults	boolean

DocumentRecordListResponseEnvelope

Name	Caminho	Tipo	Description
Registos relacionados	value	array of DocumentRecord	Registos relacionados
temMaisResultados	hasMoreResults	boolean

CreateEnvelopeResponse

Name	Caminho	Tipo	Description
Envelope Id	envelopeId	string	O id do envelope.
ID do modelo	templateId	string	A id do modelo.
Situação	status	string	O status do envelope.
Data de status e hora	statusDateTime	string	A data/hora em que o status foi definido.
URI	uri	string	O URI do envelope no DocuSign.

ListRecipientsResponse

Name	Caminho	Tipo	Description
Signatários	signers	array of Signer	Signatários

Guia

Name	Caminho	Tipo	Description
Nome da guia	name	string	O nome da guia.
Tipo de guia	tabType	string	O tipo da guia.
Etiqueta do Separador	tabLabel	string	O rótulo da guia.
Valor da guia	value	string	O valor da guia.
ID do Separador	tabId	string	O id da guia.
ID do documento	documentId	string	O id do documento.
ID do destinatário	recipientId	string	O id do destinatário.
É pré-preenchimento	prefill	boolean	Indica se a guia é do tipo pré-preenchimento.
Selecionados	selected	string	Se a caixa de seleção tabulações estiver selecionada, indica se a guia está selecionada.

RecipientTabsResponse

Name	Caminho	Tipo	Description
Guia Destinatário:	recipientTabs	array of Tab	Guia Destinatário

Signatário

Name	Caminho	Tipo	Description
Ordem de Assinatura	routingOrder	string	A ordem de assinatura do destinatário no documento.
Funções	roleName	string	O papel do signatário.
ID do destinatário	recipientId	string	O id do destinatário.
Nome	name	string	O nome do destinatário.
Email	email	string	O e-mail do destinatário.
Tipo de destinatário	recipientType	string	O digite o destinatário.
Tipo de verificação	verificationType	string	O tipo de verificação.
Destinatário Guid	recipientIdGuid	string	O destinatário Guid.

GetLoginAccountsResponse

Name	Caminho	Tipo	Description
Contas de login	loginAccounts	array of LoginAccount	Contas de login

LoginAccount

Name	Caminho	Tipo	Description
Nome	name	string	O nome da conta.
ID da conta guid	accountIdGuid	string	O GUID da conta.

ListTabsResponse

Name	Caminho	Tipo	Description
Separadores	tabs	array of Tab	Separadores

ListEnvelopeDocumentFieldsResponse

Name	Caminho	Tipo	Description
Campo Personalizado	envelopeDocumentFields	array of EnvelopeDocumentField	Campos personalizados do documento

DocGenFormFieldsResposta

Name	Caminho	Tipo	Description
Campos Docgen	docgenFields	array of DocGenFormField	Campos Docgen

DocGenFormField

Name	Caminho	Tipo	Description
ID do documento	documentId	string	ID do documento.
Etiqueta	label	string	Rótulo.
Tipo	type	string	Digite.
Nome	name	string	Nome.
Valor	value	string	valor.

ListTemplatesResponse

Name	Caminho	Tipo	Description
Modelos de envelope	envelopeTemplates	array of EnvelopeTemplate	Os modelos de envelope disponíveis.

EnvelopeTemplate

Name	Caminho	Tipo	Description
ID do modelo	templateId	string	A id do modelo.
Nome	name	string	O nome do modelo.

BulkSendListGuid

Name	Caminho	Tipo	Description
GUID da Lista de Envio em Massa	listId	string	GUID da lista de envio em massa

EnvelopeCustomFieldResponse

Name	Caminho	Tipo	Description
ID do campo	fieldId	string	A id do campo personalizado do envelope.
Tipo de campo	fieldType	string	O tipo do campo personalizado de envelope.
Nome	name	string	O nome do campo personalizado do envelope.
Valor	value	string	O valor do campo personalizado do envelope.

UpdateEnvelopeCustomFieldResponse

Name	Caminho	Tipo	Description
ID do campo	fieldId	string	A id do campo personalizado do envelope.
Tipo de campo	fieldType	string	O tipo do campo personalizado de envelope.
Nome	name	string	O nome do campo personalizado do envelope.
Valor	value	string	O valor do campo personalizado do envelope.

ListDocumentsResponse

Name	Caminho	Tipo	Description
Documentos envelope	envelopeDocuments	array of EnvelopeDocument	Os documentos anexados ao envelope.

ListTemplateDocumentsResponse

Name	Caminho	Tipo	Description
Modelo de documentos	templateDocuments	array of EnvelopeDocument	Documentos anexados a um modelo.

AddDocumentsResponse

Name	Caminho	Tipo	Description
Envelope Id	envelopeId	string	O id do envelope.
Documentos envelope	envelopeDocuments	array of EnvelopeDocument	Os documentos anexados ao envelope.

AddRecipientTabsResponse

Name	Caminho	Tipo	Description
Separadores de destinatários	recipientTabs	array of RecipientTab	As guias adicionadas a um destinatário.

EnvelopeDocument

Name	Caminho	Tipo	Description
Nome	name	string	O nome do documento.
ID do documento	documentId	string	O id do documento.
GUID do documento	documentIdGuid	string	O guid do documento.

Guia Destinatário

Name	Caminho	Tipo	Description
ID do Separador	tabId	string	O id da guia.
Tipo de guia	tabType	string	O tipo da guia.

EnvelopeDocumentField

Name	Caminho	Tipo	Description
Nome	name	string	O nome do campo personalizado.
Valor	value	string	O valor do campo personalizado.

DeclineReasonWithoutType

Motivo de Recusa

objecto

Este é o tipo 'objeto'.

Utilizar este Conector

Simplifique os processos de assinatura e integração de documentos

Partilhar via

Docusign

Title

Pré-requisitos

Obtenção de credenciais

Documentação do conector

Problemas conhecidos e limitações

Instruções de implantação

Limites de Limitação

Ações

Adicionar destinatário a um envelope (V2)

Parâmetros

Devoluções

Adicionar documentos a um envelope

Parâmetros

Devoluções

Adicionar lembretes para um envelope

Parâmetros

Devoluções

Adicionar separadores para um destinatário num envelope

Parâmetros

Devoluções

Adicionar tipo de verificação a um destinatário

Parâmetros

Anular o envelope

Parâmetros

Devoluções

Aplicar um modelo a documentos

Parâmetros

Atualizar campo personalizado do envelope

Parâmetros

Devoluções

Atualizar campos de formulário de geração de documentos a partir do envelope

Parâmetros

Atualizar destinatário em um envelope

Parâmetros

Devoluções

Atualizar guias de pré-preenchimento de envelope

Parâmetros

Atualizar valores de tabulação do destinatário em um envelope

Parâmetros

Copilot: Obter registros relacionados

Parâmetros

Devoluções

Copiloto de Vendas: Obtenha vendas-chave

Parâmetros

Devoluções

Copiloto para Vendas: Listar envelopes

Parâmetros

Devoluções

Copiloto para Vendas: Obter resumo por e-mail

Parâmetros

Devoluções

Copiloto: Listar envelopes

Parâmetros

Devoluções

Copiloto: Obtenha atividades relacionadas

Parâmetros

Devoluções

Criar envelope

Parâmetros

Devoluções

Criar envelope usando modelo

Parâmetros

Devoluções

Criar envelope usando modelo com destinatários e guias

Parâmetros

Devoluções

Criar envelope usando modelos compostos

Parâmetros

Devoluções

Criar lista de envio em massa

Parâmetros

Devoluções

DEPRECATED: Criar envelope usando modelo com destinatários

Parâmetros

Devoluções

Enviar envelope

Parâmetros

Devoluções