Docusign Demo (Pré-visualização)
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. O conector Docusign Demo se conecta apenas aos ambientes de demonstração do Docusign, mas oferece a mesma funcionalidade que o conector DocuSign de produção. Quaisquer acordos em um ambiente de demonstração Docusign não são juridicamente vinculativos.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Standard | Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Standard | Todas as regiões Power Apps exceto as seguintes: - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Standard | Todas as regiões Power Automate exceto as seguintes: - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| 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:
- Aceda a 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 é juridicamente vinculativo (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
Por favor, utilize estas instruções para implementar este 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 |
| Criar envelope (V2) |
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 |
Crie um novo envelope usando um modelo especificado e especifique os destinatários. |
| 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 |
| 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 Docusign |
Iniciar o fluxo de trabalho Docusign |
| Iniciar sessão |
Iniciar sessão |
| 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. |
| Liste os destinatários a partir de um envelope |
Liste os destinatários a partir de um envelope |
| 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. |
| OBSOLETO: Adicionar destinatário a um envelope (obsoleto) [OBSOLETO] |
Adicionar destinatário a um envelope (descontinuado). |
| OBSOLETO: Criar envelope usando modelo (obsoleto) [OBSOLETO] |
Crie um novo envelope usando um modelo especificado (obsoleto). |
| OBSOLETO: Obter documentos do envelope (obsoleto) [OBSOLETO] |
Obtenha documentos do envelope (descontinuado) |
| Obtenha informações personalizadas de campo para envelopes |
Obtenha informações personalizadas do envelope para campos. |
| 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 de formulário de geração de documentos a partir do template (apenas templates de envio em massa) |
Obter campos de formulário de geração de documentos a partir do template (apenas templates de envio em massa) |
| 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 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 |
| 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)
Adicionar destinatário a um envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
Tipo de destinatário
|
recipientType | True | string |
Introduza ou selecione um tipo de destinatário. |
|
ID de usuário do cliente
|
clientUserId | string |
ID de usuário do cliente para signatário incorporado |
|
|
ID do destinatário
|
recipientId | string |
Introduza um ID de destinatário. |
|
|
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 | string |
Para notificações por SMS, o código do país, sem sinal + à esquerda. |
|
|
Número de telefone SMS
|
phoneNumber | string |
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
Adicione documentos a um envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de 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
Adicionar lembretes para um envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de 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
Adicionar separadores para um destinatário num envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do destinatário
|
recipientId | True | string |
Introduza um ID de 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
Adicionar tipo de verificação a um destinatário
Adicione o tipo de verificação a um destinatário.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do destinatário
|
recipientId | True | string |
Introduza um ID de destinatário. |
|
Tipo de destinatário
|
recipientType | True | string |
Introduza ou selecione um 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
Anule o envelope.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
Motivo nulo
|
voidedReason | True | string |
Motivo anulado |
Devoluções
- response
- object
Aplicar um modelo a documentos
Aplicar um modelo a documentos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do modelo
|
templateId | True | string |
Introduza ou selecione um ID modelo. |
|
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
Valor de atualização para o campo personalizado de envelope especificado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de 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
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
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
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 |
|
|
Etiqueta
|
label | string |
Obrigatório para 'Linha da tabela'. Entra o rótulo do campo docgen. |
|
|
: 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
Atualizar destinatário em um envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do destinatário
|
recipientId | True | string |
Introduza um ID de 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 | string |
Para notificações por SMS, o código do país, sem sinal + à esquerda. |
|
|
Número de telefone SMS
|
phoneNumber | string |
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
Atualizar valores para uma lista de separadores de pré-preenchimento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do documento
|
documentId | True | string |
Introduza um ID de documento. |
|
Tipo
|
tabType | string |
Tipo |
|
|
ID
|
tabId | string |
ID |
|
|
Valor
|
value | string |
Valor |
Atualizar valores de tabulação do destinatário em um envelope
Atualizar valores de tabulação do destinatário em um envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do destinatário
|
recipientId | True | string |
Introduza um ID de destinatário. |
|
Tipo
|
tabType | string |
Tipo de tabulação |
|
|
ID
|
tabId | string |
ID |
|
|
Valor
|
value | string |
Valor |
Criar envelope (V2)
Crie um novo envelope em branco.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
assunto Email
|
emailSubject | True | string |
Assunto do e-mail. |
|
body
|
body | dynamic |
Corpo do email e campos personalizados da conta. |
Devoluções
Criar envelope usando modelo
Crie um novo envelope usando um modelo especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
ID do modelo
|
templateId | True | string |
Introduza ou selecione um ID modelo. |
|
Estado do envelope
|
status | True | string |
Estado do envelope |
Devoluções
Criar envelope usando modelo com destinatários
Crie um novo envelope usando um modelo especificado e especifique os destinatários.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Estado do envelope
|
status | True | string |
Estado do envelope |
|
ID do modelo
|
templateId | True | string |
Introduza ou selecione um ID 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
Criar envelope usando modelo com destinatários e guias
Criar envelope usando modelo com destinatários e guias
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
ID do modelo
|
templateId | True | string |
Introduza ou selecione um ID modelo. |
|
Destinatários
|
recipients | dynamic |
Os signatários do documento. |
|
|
Fusão de papéis e eliminação de destinatários vazios
|
merge_roles_on_draft | string |
Fusão de papéis e eliminação de destinatários vazios |
|
|
assunto Email
|
emailSubject | string |
assunto Email |
Devoluções
Criar envelope usando modelos compostos
Criar envelope usando modelos compostos
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de 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 |
|
Fusão de papéis e eliminação de destinatários vazios
|
merge_roles_on_draft | string |
Fusão de papéis e eliminação de destinatários vazios |
|
|
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
Criar lista de envio em massa
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de 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 |
|
|
Campos de geração de documentos
|
rawOutput | object |
Campos de geração de documentos |
Devoluções
- Body
- BulkSendListGuid
Enviar envelope
Envie um envelope existente.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
Devoluções
- response
- object
Enviar envelope em massa usando o modelo
Enviar envelope em massa usando o modelo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de 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)
Gerar URL de assinatura incorporada (V2)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
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
Gerar URL de assinatura incorporado [DEPRECATED]
Gerar URL de assinatura incorporada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
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
Gerar URL de remetente incorporado
Gerar URL de remetente incorporado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de 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
Iniciar o fluxo de trabalho Docusign
Iniciar o fluxo de trabalho Docusign
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de 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 |
|
variável
|
variable | dynamic |
Devoluções
TriggerMaestroFlowResponse
- response
- object
Iniciar sessão
Listar documentos de um envelope
Listar documentos de um envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
Devoluções
Listar documentos de um modelo
Listar documentos de um modelo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
ID do modelo
|
templateId | True | string |
Introduza ou selecione um ID modelo. |
Devoluções
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.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de 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 |
|
|
Palavra de pesquisa
|
search_text | string |
Introduza uma palavra-chave para encontrar correspondências nos assuntos do envelope, destinatários e campos personalizados. |
|
|
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
Liste os destinatários a partir de um envelope
Liste os destinatários a partir de um envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
Devoluções
Modelos de lista
Listar modelos para uma conta específica.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
Devoluções
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.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Número de compilação
|
buildNumber | dynamic |
Devoluções
- response
- object
OBSOLETO: Adicionar destinatário a um envelope (obsoleto) [OBSOLETO]
Adicionar destinatário a um envelope (descontinuado).
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
OBSOLETO: Criar envelope usando modelo (obsoleto) [OBSOLETO]
Crie um novo envelope usando um modelo especificado (obsoleto).
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
ID do modelo
|
templateId | True | string |
Introduza ou selecione um ID 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
OBSOLETO: Obter documentos do envelope (obsoleto) [OBSOLETO]
Obtenha documentos do envelope (descontinuado)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Account
|
accountId | True | string |
ID da conta |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de 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
Obtenha informações personalizadas de campo para envelopes
Obtenha informações personalizadas do envelope para campos.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
Nome do campo personalizado
|
fieldName | True | string |
Nome do campo personalizado |
Devoluções
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
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
Devoluções
Obter campos de formulário de geração de documentos a partir do template (apenas templates de envio em massa)
Obter campos de formulário de geração de documentos a partir do template (apenas templates de envio em massa)
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
ID do modelo
|
templateId | True | string |
Introduza ou selecione um ID modelo. |
Devoluções
Campos de formulário de geração de documentos a partir do template
- Campos do Modelo DocGen
- object
Obter campos personalizados do documento a partir do envelope
Obter campos personalizados do documento a partir do envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do documento
|
documentId | True | string |
Introduza um ID de documento. |
Devoluções
Obter documentos de um envelope
Obter documentos de um envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
Formato de saída
|
documentId | True | string |
Introduza "string(ID do documento)" para obter um único documento, ou selecione um formato. |
|
Linguagem do Certificado de Conclusão (opcional)
|
language | string |
Selecionar idioma |
Devoluções
- response
- GetDocumentsResponse
Obter informações do destinatário do envelope
Obter informações do destinatário do envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de 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 |
Introduza um ID de destinatário. |
Devoluções
- Body
- Signer
Obter informações do documento a partir do envelope
Obter informações do documento a partir do envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de 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
Devolve o valor do separador para um determinado destinatário
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do destinatário
|
recipientId | True | string |
Introduza um ID de destinatário. |
|
Rótulo da guia
|
tabLabel | True | string |
Rótulo da guia |
Devoluções
- Body
- Tab
Obter lista de eventos de auditoria
Obter lista de eventos de auditoria
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
Devoluções
- response
- object
Obter separadores de destinatários a partir do envelope
Obter separadores de destinatários a partir do envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do destinatário
|
recipientId | True | string |
Introduza um ID de destinatário. |
Devoluções
Obter separadores de documentos a partir do envelope
Obter separadores de documentos a partir do envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do documento
|
documentId | True | string |
Introduza um ID de documento. |
Devoluções
- Body
- ListTabsResponse
Obter separadores de documentos a partir do modelo
Obter separadores de documentos a partir do modelo
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
ID do modelo
|
templateId | True | string |
Introduza ou selecione um ID modelo. |
|
ID do documento
|
documentId | True | string |
Introduza um ID de documento. |
Devoluções
- Body
- ListTabsResponse
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.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
Devoluções
- response
- object
Remover destinatário de um envelope
Remover destinatário de um envelope
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Introduza ou selecione um ID de conta. |
|
Folder
|
folderId | True | string |
ID da pasta |
|
Envelope ID
|
envelopeId | True | string |
Introduza um ID de envelope. |
|
ID do destinatário
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
ID do destinatário |
Devoluções
Acionadores
| OBSOLETO: Quando o estado de um envelope muda (Conectar) (obsoleto) [OBSOLETO] |
Desencadeia um novo fluxo quando o estado de um envelope muda (obsoleto). |
| OBSOLETO: Quando o estado de um envelope muda (Conectar) (V2) (obsoleto) [OBSOLETO] |
Desencadeia um novo fluxo quando o estado de um envelope muda (obsoleto). |
| Quando ocorre um evento Docusign Connect (nível da conta) |
Aciona um novo fluxo quando o status de um envelope é alterado. |
| Quando ocorre um evento Docusign Connect (nível da organização) |
Aciona um novo fluxo quando o status de um envelope é alterado. |
OBSOLETO: Quando o estado de um envelope muda (Conectar) (obsoleto) [OBSOLETO]
Desencadeia um novo fluxo quando o estado de um envelope muda (obsoleto).
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
OBSOLETO: Quando o estado de um envelope muda (Conectar) (V2) (obsoleto) [OBSOLETO]
Desencadeia um novo fluxo quando o estado de um envelope muda (obsoleto).
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
Quando ocorre um evento Docusign Connect (nível da conta)
Aciona um novo fluxo quando o status de um envelope é alterado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da conta
|
accountId | True | string |
Insira um ID de conta ou selecione uma conta na lista suspensa. |
|
Nome da configuração Connect
|
name | True | string |
Nomeie a sua configuração Connect (por exemplo, "Eventos do Envelope"). |
|
Eventos desencadeadores
|
events | True | array of string |
Selecione um evento. Para incluir outro evento, selecione "Adicionar novo item." |
Devoluções
Quando ocorre um evento Docusign Connect (nível da organização)
Aciona um novo fluxo quando o status de um envelope é alterado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID da organização
|
organizationId | True | string |
Insira ou selecione um ID da organização. |
|
Nome da configuração Connect
|
name | True | string |
Nomeie a sua configuração Connect (por exemplo, "Eventos do Envelope"). |
|
Eventos desencadeadores
|
events | True | array of string |
Selecione um evento. Para incluir outro evento, selecione "Adicionar novo item." |
Devoluções
Definições
WebhookEnvelopeResponseV2
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Campos Personalizados de Envelope
|
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 | |
|
envelopeDocumentos
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
ID do documento
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
GUID do documento
|
data.envelopeSummary.envelopeDocuments.documentGuid | string | |
|
Nome do documento
|
data.envelopeSummary.envelopeDocuments.documentName | 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. |
WebhookOrganizationResponse
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da organização
|
data.organizationId | string |
O ID da organização. |
|
Campos Personalizados de Envelope
|
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 | |
|
envelopeDocumentos
|
data.envelopeSummary.envelopeDocuments | array of object | |
|
ID do documento
|
data.envelopeSummary.envelopeDocuments.documentId | string | |
|
GUID do documento
|
data.envelopeSummary.envelopeDocuments.documentGuid | string | |
|
Nome do documento
|
data.envelopeSummary.envelopeDocuments.documentName | 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 de Envelope
|
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 |
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 |
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 |
|---|---|---|---|
|
Envelope ID
|
envelopeId | string | |
|
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
|
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 do GUID
|
recipientIdGuid | string |
O GUID destinatário. |
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
objecto
Este é o tipo 'objeto'.