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 o risco e desbloquear o valor dos contratos que executam seus negócios.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | Todas as regiões do Power Automate , exceto as seguintes: - China Cloud operado pela 21Vianet |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Standard | Todas as regiões do Power Apps , exceto as seguintes: - China Cloud operado pela 21Vianet |
| Power Automate | Standard | Todas as regiões do Power Automate , exceto as seguintes: - China Cloud operado pela 21Vianet |
| Contato | |
|---|---|
| Nome | docusign |
| URL | https://support.docusign.com |
| Metadados do conector | |
|---|---|
| Publicador | DocuSign, Inc. |
| Site | https://www.docusign.com |
| Política de privacidade | https://www.docusign.com/company/privacy-policy |
| Categorias | Conteúdo e arquivos; Produtividade |
Title
O DocuSign ajuda as organizações a se conectarem e automatizarem como se preparam, assinam, agem e gerenciam contratos. O conector de demonstração do DocuSign conecta-se apenas aos ambientes de Demonstração do DocuSign, mas oferece a mesma funcionalidade que o conector DocuSign regular. Todos os documentos em um ambiente de demonstração do DocuSign não são legalmente vinculantes. Para todos os usos que não são de demonstração, use o conector DocuSign regular.
Pré-requisitos
Para usar o gatilho Connect nessa integração, o DocuSign Connect deve estar habilitado em sua conta do DocuSign. Ele não está habilitado por padrão. Depois de habilitada, a página Desativar Configurações pode ser acessada no aplicativo Web DocuSign Admin. O uso do gatilho Connect nessa integração registrará automaticamente o webhook para você.
Obtendo credenciais
Para experimentar o conector, use uma conta DEMO:
- Ir para https://developers.docusign.com/
- Criar conta de área restrita.
Elas são diferentes das avaliações gratuitas em que nunca expiram, têm 90% de nossos recursos de conta paga e nenhum dos documentos enviados por DEMO são legalmente vinculantes ((https://support.docusign.com/en/articles/Free-account-vs-Developer-account).
Documentação do conector
Para obter uma documentação detalhada em torno do conector, consulte https://support.docusign.com/en/guides/DocuSign-eSignature-for-Microsoft-Power-Automate
Problemas e limitações conhecidos
Para problemas com o DocuSign, 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 no Power Apps.
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 250 | 60 segundos |
Ações
| Adicionar destinatário a um envelope (V2) |
Adicione o destinatário a um envelope. |
| Adicionar documentos a um envelope |
Adicione documentos a um envelope. |
| Adicionar guias para um destinatário em um envelope |
Adicionar guias para um destinatário em um envelope |
| Adicionar lembretes para um envelope |
Adicionar lembretes para um envelope |
| Adicionar tipo de verificação a um destinatário |
Adicione o tipo de verificação a um destinatário. |
| Anular o envelope |
Anula o envelope. |
| Aplicar um modelo a documentos |
Aplicar um modelo a documentos |
| Atualizar campos de formulário de geração de documento do envelope |
Atualizar campos de formulário de geração de documento 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 guias de pré-preenchimento |
| Atualizar o campo personalizado do envelope |
Atualizar o valor do campo personalizado do envelope especificado |
| Atualizar valores de guia do destinatário em um envelope |
Atualizar valores de guia do destinatário em um envelope |
| Copilot for Sales: Listar envelopes |
Copilot for Sales: Os envelopes de lista retornam informações sobre contratos do Docusign, como título, documentos, destinatários, status do contrato, nome do remetente e URL do contrato. O plug-in pode lidar com solicitações como mostrar todos os meus contratos que preciso assinar ou qual é o status do contrato de pedido de vendas. |
| Copilot for Sales: Obter resumo de email |
Essa ação obtém insights de vendas adicionais que serão mostrados na experiência de resumo de email do C4S dentro do resumo do Outlook. A ação aprimora as habilidades existentes do copilot para vendas. |
| Copilot for Sales: Obter vendas de chaves |
Essa ação obtém insights adicionais sobre vendas que serão mostrados no cartão de informações das principais vendas C4S no complemento do Outlook. A ação aprimora as habilidades existentes do copilot para vendas |
| Copilot: Listar envelopes |
Essa ação traz envelopes Docusign relevantes com base no status do envelope, intervalo de datas, nome do destinatário, endereço de email 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, a ID do envelope, os nomes dos documentos, os nomes do remetente, o status do envelope, a data de status, a data enviada e uma URL do envelope que pode ser usada como um link para exibir o envelope em Docusign. |
| Copilot: Obter atividades relacionadas |
Essa ação obtém insights de vendas adicionais relacionados a um registro de CRM que serão mostrados no cartão de resumo do registro C4S. A ação aprimora as habilidades existentes do copilot para vendas. |
| Copilot: Obter registros relacionados |
Essa ação obtém registros relacionados a um registro CRM. A ação aprimora as habilidades existentes do Copilot for Sales. |
| 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 de composição |
Criar envelope usando modelos de composição |
| Criar lista de envio em massa |
Criar lista de envio em massa |
| Entrar |
Entrar |
| Enviar envelope |
Enviar um envelope existente. |
| Enviar envelope em massa usando o modelo |
Enviar envelope em massa usando o modelo |
| Gerar URL de Assinatura Inserida (V2) |
Gerar URL de Assinatura Inserida (V2) |
| Gerar URL de Assinatura Inserida [PRETERIDA] |
Gerar URL de Assinatura Inserida |
| Gerar URL do Remetente Inserido |
Gerar URL do Remetente Inserido |
| Iniciar fluxo de trabalho do Docusign Maestro |
Iniciar fluxo de trabalho do Docusign Maestro |
| 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 |
Essa ação traz envelopes Docusign relevantes com base no status do envelope, intervalo de datas, nome do destinatário, endereço de email 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, a ID do envelope, os nomes dos documentos, os nomes do remetente, o status do envelope, a data de status, a data enviada e uma URL do envelope que pode ser usada como um link para exibir o envelope em Docusign. |
| Listar modelos |
Listar modelos para uma conta específica. |
| Mostrar número de build (somente para referência. Não inclua em um fluxo para execução) |
Identificador para o build implantado no momento. |
| Obter campos de formulário de geração de documento do envelope |
Obter campos de formulário de geração de documento do envelope |
| Obter campos personalizados do documento do envelope |
Obter campos personalizados do documento do envelope |
| Obter documentos de um envelope |
Obter documentos de um envelope |
| Obter guias de documento do envelope |
Obter guias de documento do envelope |
| Obter guias de documento do modelo |
Obter guias de documento do modelo |
| Obter guias do destinatário do envelope |
Obter guias do destinatário do 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 do envelope |
Obter informações do documento do envelope |
| Obter informações para a guia destinatário |
Retorna o valor da guia para o destinatário fornecido |
| Obter lista de eventos de auditoria |
Obter lista de eventos de auditoria |
| PRETERIDO: Adicionar destinatário a um envelope |
Adicione o destinatário a um envelope. |
| PRETERIDO: Criar envelope usando modelo com destinatários |
Crie um envelope usando um modelo especificado e especifique destinatários. |
| PRETERIDO: Criar envelope usando o modelo |
Crie um novo envelope usando um modelo especificado. |
| PRETERIDO: Obter documentos do envelope |
Obter documentos do envelope |
| Reenviar o envelope |
Essa 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)
Adicione o destinatário a um envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
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 do usuário cliente
|
clientUserId | string |
ID do usuário cliente para o signatário inserido |
|
|
URL de início do destinatário inserido
|
embeddedRecipientStartURL | string |
Uma cadeia de caracteres de URL fornecida pelo remetente para redirecionar um destinatário inserido. |
|
|
Ordem de assinatura
|
routingOrder | string |
A ordem de assinatura do destinatário. |
|
|
Idioma de notificação por email
|
emailNotificationLanguage | string |
Idioma para a notificação por email. |
|
|
Assunto da notificação por email
|
emailNotificationSubject | string |
Assunto da notificação por email. |
|
|
Corpo da notificação por email
|
emailNotificationBody | string |
Corpo da notificação por email. |
|
|
Observação
|
note | string |
Anotação personalizada para o destinatário. |
|
|
Nome da função
|
roleName | string |
Nome da função associado ao destinatário. |
|
|
Código do país SMS
|
countryCode | integer |
Para notificações por SMS, o código do país, sem a liderança + sinal. |
|
|
Número de telefone SMS
|
phoneNumber | integer |
Email do signatário ou telefone SMS necessário. Exclua o código do país para o número de telefone. |
|
|
Grupo de assinatura
|
signingGroupId | string |
Grupo de assinatura |
|
|
Tipo de assinatura
|
signatureType | string |
Tipos SBS (assinatura baseada em padrões) do DocuSign. |
|
|
Fluxo de trabalho de verificação
|
workflowId | string |
Fluxos de trabalho IDV com tipos de assinatura de caneta devem ser selecionados aqui. |
|
|
detalhes do tipo de destinatário selecionado
|
additionalRecipientParams | dynamic |
Detalhes do tipo de destinatário selecionado. |
Retornos
- Corpo
- Signer
Adicionar documentos a um envelope
Adicione documentos a um envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
Documento Base64 *
|
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 guias ao destinatário
|
assignTabsToRecipientId | string |
ID do destinatário |
Retornos
- Corpo
- AddDocumentsResponse
Adicionar guias para um destinatário em um envelope
Adicionar guias para um destinatário em um envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
Recipient
|
recipientId | True | string |
ID do destinatário |
|
Tipo de guia
|
tabType | True | string |
Tipo de guia |
|
detalhes da guia
|
tabDetails | True | dynamic |
Os detalhes da guia de âncora selecionada. |
Retornos
- Corpo
- AddRecipientTabsResponse
Adicionar lembretes para um envelope
Adicionar lembretes para um envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
Lembrete habilitado
|
reminderEnabled | True | boolean |
Quando definido como false, os lembretes são desabilitados. O padrão é falso |
|
Atraso do lembrete
|
reminderDelay | True | string |
Adicione o número de dias após o qual o destinatário recebe um email de lembrete. |
|
Frequência de lembrete
|
reminderFrequency | True | string |
Adicione o número de dias entre emails de lembrete. |
|
Expirar após
|
expireAfter | string |
Adicione o número de dias antes da expiração. |
Retornos
- Corpo
- AddRemindersResponse
Adicionar tipo de verificação a um destinatário
Adicione o tipo de verificação a um destinatário.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
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
Anula o envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
Motivo nulo
|
voidedReason | True | string |
Motivo anulado |
Retornos
- response
- object
Aplicar um modelo a documentos
Aplicar um modelo a documentos
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
AccountID |
|
Envelope ID
|
envelopeId | True | string |
Envelope ID |
|
Template
|
templateId | True | string |
Template |
|
Preservar o 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 campos de formulário de geração de documento do envelope
Atualizar campos de formulário de geração de documento do envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
AccountID |
|
Envelope
|
envelopeId | True | string |
Envelope ID |
|
GUID do documento
|
documentGuid | True | string |
GUID do documento |
|
Tipo
|
fieldType | string |
Escolher o tipo de campo de geração de documento a ser atualizado |
|
|
Nome
|
name | string |
Insira o nome do campo ou o nome da coluna da tabela |
|
|
Value
|
value | string |
Insira os dados do campo |
|
|
: nome da tabela
|
tableName | string |
Necessário para 'Table Row'. Insira o nome da tabela. |
|
|
: Linha da Tabela
|
rowNumber | string |
Necessário para 'Table Row'. Insira o número da linha |
Atualizar destinatário em um envelope
Atualizar destinatário em um envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
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 SBS (assinatura baseada em padrões) do DocuSign. |
|
|
Tipo de destinatário
|
recipientType | True | string |
Tipo de destinatário |
|
ID do usuário cliente
|
clientUserId | string |
ID do usuário cliente para o signatário inserido |
|
|
URL de início do destinatário inserido
|
embeddedRecipientStartURL | string |
Uma cadeia de caracteres de URL fornecida pelo remetente para redirecionar um destinatário inserido. |
|
|
Ordem de assinatura
|
routingOrder | string |
A ordem de assinatura do destinatário. |
|
|
Idioma de notificação por email
|
emailNotificationLanguage | string |
Idioma para a notificação por email. |
|
|
Assunto da notificação por email
|
emailNotificationSubject | string |
Assunto da notificação por email. |
|
|
Corpo da notificação por email
|
emailNotificationBody | string |
Corpo da notificação por email. |
|
|
Observação
|
note | string |
Anotação personalizada para o destinatário. |
|
|
Nome da função
|
roleName | string |
Nome da função associado ao destinatário. |
|
|
Código do país SMS
|
countryCode | integer |
Para notificações por SMS, o código do país, sem a liderança + sinal. |
|
|
Número de telefone SMS
|
phoneNumber | integer |
Email do signatário ou telefone SMS necessário. Exclua o código 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. |
Retornos
- Corpo
- Signer
Atualizar guias de pré-preenchimento de envelope
Atualizar valores para uma lista de guias de pré-preenchimento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
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 |
|
|
Value
|
value | string |
Value |
Atualizar o campo personalizado do envelope
Atualizar o valor do campo personalizado do envelope especificado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
ID do campo
|
fieldId | True | string |
ID do campo personalizado |
|
Tipo de campo
|
fieldType | True | string |
Tipo de campo personalizado |
|
Nome
|
name | True | string |
Nome do campo personalizado |
|
Value
|
value | True | string |
Valor do campo personalizado |
Retornos
Atualizar valores de guia do destinatário em um envelope
Atualizar valores de guia do destinatário em um envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
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 guia |
|
|
ID
|
tabId | string |
ID |
|
|
Value
|
value | string |
Value |
Copilot for Sales: Listar envelopes
Copilot for Sales: Os envelopes de lista retornam informações sobre contratos do Docusign, como título, documentos, destinatários, status do contrato, nome do remetente e URL do contrato. O plug-in pode lidar com solicitações como mostrar todos os meus contratos que preciso assinar ou qual é o status do contrato de pedido de vendas.
Parâmetros
| Nome | Chave | Obrigatório | 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 na ID de email do destinatário |
|
|
Assunto do envelope
|
envelopeTitle | string |
Esta ação lista envelopes com base no assunto do email 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 |
|
|
Status do envelope
|
envelopeStatus | string |
Esta ação lista envelopes com base no status do envelope |
|
|
Pasta
|
folder_ids | string |
Esta ação lista envelopes com base em vários estados do envelope |
|
|
Ordem por
|
order_by | string |
Esta ação ordena envelopes com base em uma propriedade específica |
|
|
TOP
|
top | integer |
Envelopes principais a serem retornados |
|
|
Ignorar
|
skip | integer |
Envelopes a serem ignorados |
|
|
Data de início
|
startDateTime | date-time |
Insira a data e hora de início no formato: 2017-05-02T01:44Z |
|
|
Data de término
|
endDateTime | date-time |
Insira a data e hora de término no formato: 2017-05-02T01:44Z |
Retornos
Copilot for Sales: Obter resumo de email
Essa ação obtém insights de vendas adicionais que serão mostrados na experiência de resumo de email do C4S dentro do resumo do Outlook. A ação aprimora as habilidades existentes do copilot para vendas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
recordType | string |
Essa entrada identifica o tipo de registro no CRM que está relacionado ao email resumido. |
|
|
ID do registro
|
recordId | string |
Essa entrada fornece o identificador exclusivo do registro CRM que está relacionado ao email resumido. |
|
|
Tipo de CRM
|
crmType | string |
Essa entrada indica o tipo de CRM no qual o registro relacionado ao email resumido existe. |
|
|
URL da organização CRM
|
crmOrgUrl | string |
Essa entrada indica a URL do ambiente crm no qual o registro relacionado ao email resumido existe. |
|
|
Endereços de email separados por vírgula
|
emailContacts | True | string |
Essa entrada indica uma lista de todos os emails de participante relevantes no thread de email atual. |
|
TOP
|
top | integer |
Esta entrada indica o número de insights a serem buscados. |
|
|
Ignorar
|
skip | integer |
Essa entrada indica o número de itens a serem ignoradas ao buscar insights. |
Retornos
- Corpo
- EmailSummaryResponse
Copilot for Sales: Obter vendas de chaves
Essa ação obtém insights adicionais sobre vendas que serão mostrados no cartão de informações das principais vendas C4S no complemento do Outlook. A ação aprimora as habilidades existentes do copilot para vendas
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
recordType | True | string |
Essa entrada identifica o tipo de registro no CRM para o qual as informações de vendas de chave são solicitadas. |
|
ID do registro
|
recordId | True | string |
Essa entrada fornece o identificador exclusivo do registro CRM para o qual as informações de vendas de chave são solicitadas. |
|
Data de início
|
startDateTime | date-time |
Insira a data e hora de início no formato: 2017-05-02T01:44Z |
|
|
TOP
|
top | integer |
Essa entrada indica o número de destaques de vendas a serem buscados. |
|
|
Ignorar
|
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 do CRM existe, para o qual as principais informações de vendas são solicitadas. |
|
|
URL da organização CRM
|
crmOrgUrl | string |
Essa entrada indica a URL do ambiente CRM no qual o registro CRM existe, para o qual as principais informações de vendas são solicitadas. |
Retornos
- Corpo
- KeySalesResponse
Copilot: Listar envelopes
Essa ação traz envelopes Docusign relevantes com base no status do envelope, intervalo de datas, nome do destinatário, endereço de email 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, a ID do envelope, os nomes dos documentos, os nomes do remetente, o status do envelope, a data de status, a data enviada e uma URL do envelope que pode ser usada como um link para exibir o envelope em Docusign.
Parâmetros
| Nome | Chave | Obrigatório | 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 na ID de email do destinatário |
|
|
Assunto do envelope
|
envelopeTitle | string |
Esta ação lista envelopes com base no assunto do email 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 |
|
|
Status do envelope
|
envelopeStatus | string |
Esta ação lista envelopes com base no status do envelope |
|
|
Pasta
|
folder_ids | string |
Esta ação lista envelopes com base em vários estados do envelope |
|
|
Ordem por
|
order_by | string |
Esta ação ordena envelopes com base em uma propriedade específica |
|
|
TOP
|
top | integer |
Envelopes principais a serem retornados |
|
|
Ignorar
|
skip | integer |
Envelopes a serem ignorados |
|
|
Data de início
|
from_date | date-time |
Insira '' 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 término
|
to_date | date-time |
Insira '' quando nenhum valor for fornecido pelo usuário. Insira a data e hora de término no padrão ou formato: 2017-05-02T01:44Z. |
Retornos
Copilot: Obter atividades relacionadas
Essa ação obtém insights de vendas adicionais relacionados a um registro de CRM que serão mostrados no cartão de resumo do registro C4S. A ação aprimora as habilidades existentes do copilot para vendas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
recordType | True | string |
Esta entrada indica o tipo de entidade ou objeto no CRM para o qual insights relacionados são solicitados. |
|
ID do registro
|
recordId | True | string |
Esta entrada indica o identificador exclusivo do registro de CRM para o qual insights relacionados são solicitados. |
|
Data de início
|
startDateTime | date-time |
Esta entrada indica a data de início e a hora de insights solicitados. |
|
|
Data de término
|
endDateTime | date-time |
Esta entrada indica a data de término e a hora de insights solicitados. |
|
|
TOP
|
top | integer |
Esta entrada indica o número de insights a serem buscados. |
|
|
Ignorar
|
skip | integer |
Esta entrada indica o número de insights a serem ignorados. |
|
|
Tipo de CRM
|
crmType | string |
Esta entrada indica o tipo de CRM no qual o registro de CRM existe, para o qual os insights são solicitados. |
|
|
URL da organização CRM
|
crmOrgUrl | string |
Esta entrada indica a URL do ambiente de CRM no qual o registro de CRM existe, para o qual os insights são solicitados. |
Retornos
Copilot: Obter registros relacionados
Essa ação obtém registros relacionados a um registro CRM. A ação aprimora as habilidades existentes do Copilot for Sales.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de registro
|
recordType | True | string |
Essa entrada identifica o tipo de registro no CRM para o qual os registros relacionados são solicitados. |
|
ID do registro
|
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 e hora de início no formato: 2017-05-02T01:44Z |
|
|
TOP
|
top | integer |
Essa entrada indica o número de registros relacionados a serem buscados. |
|
|
Ignorar
|
skip | integer |
Essa entrada indica o número de registros a serem ignoradas 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 CRM
|
crmOrgUrl | string |
Essa entrada indica a URL do ambiente crm do qual os registros relacionados são buscados. |
Retornos
Criar envelope
Crie um novo envelope em branco.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Assunto do email
|
emailSubject | True | string |
Assunto do e-mail. |
|
Corpo do e-mail
|
emailBody | string |
Corpo do email. |
|
|
Campos personalizados
|
accountCustomFields | dynamic |
Obtenha os campos personalizados definidos no nível da conta. |
Retornos
- Corpo
- CreateEnvelopeResponse
Criar envelope usando modelo
Crie um novo envelope usando um modelo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Template
|
templateId | True | string |
ID do modelo |
|
Status do envelope
|
status | True | string |
Status do envelope |
Retornos
- Corpo
- CreateEnvelopeResponse
Criar envelope usando modelo com destinatários e guias
Criar envelope usando modelo com destinatários e guias
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
AccountID |
|
Template
|
templateId | True | string |
ID do Modelo |
|
Destinatários
|
recipients | dynamic |
Os signatários do documento. |
|
|
Assunto do email
|
emailSubject | string |
Assunto do email |
Retornos
- Corpo
- CreateEnvelopeResponse
Criar envelope usando modelos de composição
Criar envelope usando modelos de composição
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Assunto do email
|
emailSubject | True | string |
Assunto do e-mail. |
|
Corpo do e-mail
|
emailBody | string |
Corpo do email. |
|
|
Status do envelope
|
status | True | string |
Status do envelope |
|
body
|
body | dynamic |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Envelope Id
|
envelopeId | string |
A ID do envelope. |
|
Situação
|
status | string |
O status do envelope. |
|
Data e hora do status
|
statusDateTime | string |
O datetime em que o status foi definido. |
|
URI
|
uri | string |
O URI do envelope em DocuSign. |
Criar lista de envio em massa
Criar lista de envio em massa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
AccountID |
|
Nome da lista de envio em massa
|
name | True | string |
Nome da lista de envio em massa |
|
Arquivo CSV
|
csv | string |
Carregar arquivo CSV |
Retornos
- Corpo
- BulkSendListGuid
Entrar
Enviar envelope
Enviar um envelope existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
Retornos
- response
- object
Enviar envelope em massa usando o modelo
Enviar envelope em massa usando o modelo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
AccountID |
|
GUID da lista de envio em massa
|
bulkSendListId | True | string |
GUID da lista de envio em massa |
|
ID do Modelo
|
envelopeOrTemplateId | True | string |
Insira a ID do modelo ou escolha um modelo na lista suspensa |
Retornos
- Corpo
- BulkSendListGuid
Gerar URL de Assinatura Inserida (V2)
Gerar URL de Assinatura Inserida (V2)
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
AccountID |
|
Envelope
|
envelopeId | True | string |
Envelope ID |
|
É um signatário pessoal?
|
isInPersonSigner | True | string |
Sim/Não |
|
Método de autenticação
|
authenticationMethod | True | string |
Método de autenticação |
|
URL de retorno
|
returnUrl | True | string |
URL de retorno |
|
URL adicional adicionada
|
additionalURL | True | dynamic |
URL adicional adicionada. |
Retornos
- Corpo
- EmbeddedSigningResponse
Gerar URL de Assinatura Inserida [PRETERIDA]
Gerar URL de Assinatura Inserida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
AccountID |
|
Envelope
|
envelopeId | True | string |
Envelope ID |
|
Nome do signatário
|
signerName | True | string |
Nome do signatário |
|
Email do signatário
|
signerEmail | True | string |
Email do signatário |
|
ID do usuário cliente
|
clientUserId | string |
Obrigatório, a menos que o signatário esteja pessoalmente. Deixar em branco para signatários pessoais |
|
|
Método de autenticação
|
authenticationMethod | True | string |
Método de autenticação |
|
URL de retorno
|
returnUrl | True | string |
URL de retorno |
|
URL adicional adicionada
|
additionalURL | dynamic |
URL adicional adicionada. |
Retornos
- Corpo
- EmbeddedSigningResponse
Gerar URL do Remetente Inserido
Gerar URL do Remetente Inserido
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
Abrir em
|
openIn | True | string |
Abrir em |
|
URL de retorno
|
returnUrl | True | string |
URL de retorno |
|
URL adicional adicionada
|
additionalURL | dynamic |
URL adicional adicionada. |
Retornos
- Corpo
- EmbeddedSenderResponse
Iniciar fluxo de trabalho do Docusign Maestro
Iniciar fluxo de trabalho do Docusign Maestro
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
AccountID |
|
fluxo de trabalho
|
workflowId | True | string |
Insira a 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 de fluxo de trabalho do Maestro |
|
variável
|
variable | dynamic |
Retornos
TriggerMaestroFlowResponse
- response
- object
Listar destinatários do envelope
Listar destinatários do envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Pasta
|
folderId | True | string |
ID da pasta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
Retornos
- Corpo
- ListRecipientsResponse
Listar documentos de um envelope
Listar documentos de um envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
Retornos
- Corpo
- ListDocumentsResponse
Listar documentos de um modelo
Listar documentos de um modelo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Template
|
templateId | True | string |
ID do modelo |
Retornos
Listar envelopes
Essa ação traz envelopes Docusign relevantes com base no status do envelope, intervalo de datas, nome do destinatário, endereço de email 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, a ID do envelope, os nomes dos documentos, os nomes do remetente, o status do envelope, a data de status, a data enviada e uma URL do envelope que pode ser usada como um link para exibir o envelope em Docusign.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
AccountID |
|
Nome do destinatário
|
recipientName | string |
Esta ação lista envelopes com base no nome do destinatário |
|
|
Email do destinatário
|
recipientEmailId | string |
Filtra envelopes por email do destinatário |
|
|
Assunto do envelope
|
envelopeTitle | string |
Filtra envelopes por assunto de 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 |
|
|
Status do envelope
|
envelopeStatus | string |
Esta ação lista envelopes com base no status do envelope |
|
|
Pasta
|
folder_ids | string |
Filtra envelopes pela pasta selecionada |
|
|
Ordem por
|
order_by | string |
Classifica envelopes na ordem selecionada |
|
|
Envelopes de retorno
|
top | integer |
Especifique o número de envelopes a serem retornados (o padrão é 10; o máximo é 1.000) |
|
|
Ignorar envelopes
|
skip | integer |
Especifique o número de envelopes a serem ignoradas desde o início |
|
|
Data de início
|
from_date | date-time |
Insira a data e hora de início no formato UTC: 2017-05-02T01:44z |
|
|
Data de término
|
to_date | date-time |
Insira a data e hora de término no formato UTC: 2017-05-02T01:44z. |
Retornos
Listar modelos
Listar modelos para uma conta específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
Retornos
- Corpo
- ListTemplatesResponse
Mostrar número de build (somente para referência. Não inclua em um fluxo para execução)
Identificador para o build implantado no momento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Número da Compilação
|
buildNumber | dynamic |
Retornos
- response
- object
Obter campos de formulário de geração de documento do envelope
Obter campos de formulário de geração de documento do envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
Retornos
- Corpo
- DocGenFormFieldsResponse
Obter campos personalizados do documento do envelope
Obter campos personalizados do documento do envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
ID do documento
|
documentId | True | string |
ID do documento |
Retornos
Obter documentos de um envelope
Obter documentos de um envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
Formato da saída
|
documentId | True | string |
Forneça uma ID de documento específica ou use um formato de saída na lista suspensa |
Retornos
- response
- GetDocumentsResponse
Obter guias de documento do envelope
Obter guias de documento do envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
ID do documento
|
documentId | True | string |
ID do documento |
Retornos
- Corpo
- ListTabsResponse
Obter guias de documento do modelo
Obter guias de documento do modelo
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Template
|
templateId | True | string |
ID do modelo |
|
ID do documento
|
documentId | True | string |
ID do documento |
Retornos
- Corpo
- ListTabsResponse
Obter guias do destinatário do envelope
Obter guias do destinatário do envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
ID do destinatário
|
recipientId | True | string |
ID do destinatário |
Retornos
- Corpo
- RecipientTabsResponse
Obter informações de campo personalizadas do envelope
Obter informações de campo personalizadas do envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
Nome do campo personalizado
|
fieldName | True | string |
Nome do campo personalizado |
Retornos
Obter informações do destinatário do envelope
Obter informações do destinatário do envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
Email do destinatário
|
recipientEmail | string |
Email 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 |
Retornos
- Corpo
- Signer
Obter informações do documento do envelope
Obter informações do documento do envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
Nome do documento
|
documentName | True | string |
Nome do arquivo com extensão |
Retornos
- Corpo
- EnvelopeDocument
Obter informações para a guia destinatário
Retorna o valor da guia para o destinatário fornecido
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
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 de tabulação
|
tabLabel | True | string |
Rótulo de tabulação |
Retornos
- Corpo
- Tab
Obter lista de eventos de auditoria
Obter lista de eventos de auditoria
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
Retornos
- response
- object
PRETERIDO: Adicionar destinatário a um envelope
Adicione o destinatário a um envelope.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
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. |
|
Email do signatário
|
AddRecipientToEnvelopeEmail | True | string |
O email do destinatário. |
|
Ordem de Assinatura
|
routingOrder | string |
A ordem de assinatura do destinatário no documento. |
|
|
Função
|
roleName | string |
A função do signatário. |
Retornos
- Corpo
- ListRecipientsResponse
PRETERIDO: Criar envelope usando modelo com destinatários
Crie um envelope usando um modelo especificado e especifique destinatários.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Status do envelope
|
status | True | string |
Status do envelope |
|
Template
|
templateId | True | string |
ID do modelo |
|
Signatários
|
signers | dynamic |
Os signatários do documento. |
|
|
Assunto do email
|
emailSubject | string |
Assunto do email |
|
|
Corpo do e-mail
|
emailBody | string |
Corpo do e-mail |
Retornos
- Corpo
- CreateEnvelopeResponse
PRETERIDO: Criar envelope usando o modelo
Crie um novo envelope usando um modelo especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Template
|
templateId | True | string |
ID do modelo |
|
Status do envelope
|
status | True | string |
Status do envelope |
|
Campos personalizados
|
accountCustomFields | True | dynamic |
Obtenha os campos personalizados definidos no nível da conta. |
Retornos
- Corpo
- CreateEnvelopeResponse
PRETERIDO: Obter documentos do envelope
Obter documentos do envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
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 do envelope é removido do download. |
Retornos
- response
- GetDocumentsResponse
Reenviar o envelope
Essa 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
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Envelope
|
envelopeId | True | string |
ID do envelope |
Retornos
- response
- object
Remover destinatário de um envelope
Remover destinatário de um envelope
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Pasta
|
folderId | True | string |
ID da pasta |
|
Envelope
|
envelopeId | True | string |
ID do envelope |
|
Recipient
|
RemoveRecipientFromEnvelopeRecipientId | True | string |
ID do destinatário |
Retornos
- Corpo
- ListRecipientsResponse
Gatilhos
| PRETERIDO: Quando um status de envelope é alterado (Conectar) |
Dispara um novo fluxo quando um status de envelope é alterado. |
| PRETERIDO: Quando um status de envelope é alterado (Connect) (V2) |
Dispara um novo fluxo quando um status de envelope é alterado. |
| Quando um status de envelope é alterado (Connect) (V3) |
Dispara um novo fluxo quando um status de envelope é alterado. |
PRETERIDO: Quando um status de envelope é alterado (Conectar)
Dispara um novo fluxo quando um status de envelope é alterado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Nome da conexão
|
name | True | string | |
|
Evento envelope
|
envelopeEvents | True | string |
Retornos
- Corpo
- WebhookEnvelopeResponse
PRETERIDO: Quando um status de envelope é alterado (Connect) (V2)
Dispara um novo fluxo quando um status de envelope é alterado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Nome da conexão
|
name | True | string | |
|
Evento envelope
|
envelopeEvents | True | string |
Retornos
Quando um status de envelope é alterado (Connect) (V3)
Dispara um novo fluxo quando um status de envelope é alterado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Conta
|
accountId | True | string |
ID da conta |
|
Nome da conexão
|
name | True | string | |
|
Evento envelope
|
envelopeEvents | True | string |
Retornos
Definições
WebhookEnvelopeResponseV2
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campos personalizados
|
data.envelopeSummary.customFields | object |
Pares chave-valor que representam os campos personalizados para este envelope (onde a chave é o nome do campo e o valor é o valor do campo). |
|
Envelope Criado Date-Time
|
data.envelopeSummary.createdDateTime | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Envelope ID
|
data.envelopeSummary.envelopeId | string | |
|
Envelope enviado Date-Time
|
data.envelopeSummary.sentDateTime | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Envelope Status
|
data.envelopeSummary.status | string | |
|
Assunto de email
|
data.envelopeSummary.emailSubject | string | |
|
Nome do remetente
|
data.envelopeSummary.sender.userName | string | |
|
ID de usuário do remetente
|
data.envelopeSummary.sender.userId | string | |
|
ID da conta do remetente
|
data.envelopeSummary.sender.accountId | string | |
|
Endereço de email do remetente
|
data.envelopeSummary.sender.email | string | |
|
Signatários
|
data.envelopeSummary.recipients.signers | array of object | |
|
Guias
|
data.envelopeSummary.recipients.signers.tabs | object |
Pares chave-valor que representam as guias desse destinatário (onde a chave é o nome do campo e o valor é o valor do campo). |
|
Email 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 |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Status do destinatário
|
data.envelopeSummary.recipients.signers.status | string |
O status 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 da verificação. |
|
Nome do destinatário
|
data.envelopeSummary.recipients.signers.name | string |
O nome do destinatário. |
WebhookEnvelopeResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campos personalizados
|
customFields | object |
Pares chave-valor que representam os campos personalizados para este envelope (onde a chave é o nome do campo e o valor é o valor do campo). |
|
Envelope Criado Date-Time
|
DocuSignEnvelopeInformation.EnvelopeStatus.Created | date-time |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Endereço de email 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 |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Envelope Status
|
DocuSignEnvelopeInformation.EnvelopeStatus.Status | string | |
|
Assunto
|
DocuSignEnvelopeInformation.EnvelopeStatus.Subject | string | |
|
Nome do remetente
|
DocuSignEnvelopeInformation.EnvelopeStatus.UserName | string | |
|
RecipientStatus
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus | array of object | |
|
Guias
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.tabs | object |
Pares chave-valor que representam as guias desse destinatário (onde a chave é o nome do campo e o valor é o valor do campo). |
|
Motivo do declínio
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.DeclineReason | DeclineReasonWithoutType | |
|
Email 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 |
yyyyy-MM-ddTHH:mm:ss.fffZ |
|
Status do destinatário
|
DocuSignEnvelopeInformation.EnvelopeStatus.RecipientStatuses.RecipientStatus.Status | string |
O status 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 arquivo
- binary
AddRemindersResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Lembrete habilitado
|
reminderEnabled | string |
Lembrete habilitado |
FilteredEnvelopes
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Title
|
title | string |
Título do envelope |
|
Description
|
description | string |
Descrição da atividade de envelope |
|
Envelope ID
|
envelopeId | string |
Envelope ID |
|
Documentos
|
documents | string |
Lista de nomes de documentos |
|
Nomes de destinatário
|
recipients | string |
Lista de nomes de destinatário |
|
Nome do remetente
|
sender | string |
Nome do remetente |
|
Situação
|
status | string |
Status do envelope |
|
Data de status
|
statusDate | string |
Última atualização de status da atividade |
|
Data enviada
|
dateSent | date-time |
Data de envio do envelope |
|
URL
|
url | string |
URL do envelope |
SalesCopilotFilteredEnvelopes
| Nome | 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Title
|
title | string |
Esta saída indica o título da atividade no cartão de citação. |
|
Description
|
description | string |
Esta saída indica a descrição do insight. |
|
DateTime
|
dateTime | date-time |
Esta saída indica o tempo associado ao insight. |
|
URL
|
url | string |
Esta saída indica a URL para abrir o insight. |
|
Propriedades adicionais
|
additionalProperties.additionalProperties | string |
Propriedades adicionais da atividade |
EmailSummary
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Title
|
Title | string |
Essa 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 você gostaria de incluir no resumo de email. |
KeySales
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Title
|
Title | string |
Esse resultado indica o título do cartão de citação para o insight. |
|
descrição
|
description | string |
Esse resultado indica o texto do insight a ser incluído nas informações de vendas principais. |
|
URL do envelope
|
url | string |
Essa saída fornece a URL para obter mais informações sobre o insight. |
|
Tempo associado ao insight
|
dateTime | string |
Esta saída indica o tempo associado ao insight. |
|
Propriedades adicionais
|
additionalProperties.additionalProperties | string |
Essa saída indica propriedades adicionais como pares nome-valor de cada insight relacionado retornado pela ação. |
DocumentRecord
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do registro
|
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 de 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 registro
|
recordType | string |
Essa saída indica o tipo de cada registro relacionado retornado pela ação. |
|
Título do registro
|
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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL do Remetente Inserido
|
url | string |
A URL do modo de exibição do remetente inserido. |
EmbeddedSigningResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URL
|
url | string |
A URL do modo de exibição de assinatura inserido. |
FilteredEnvelopeListResponse
| Nome | 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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Envelopes filtrados
|
value | array of SalesCopilotFilteredEnvelopes |
Envelopes filtrados |
|
tem mais resultados
|
hasMoreResults | boolean |
ActivityListResponseEnvelope
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Atividades relacionadas
|
value | array of Activity |
Ativações relacionadas |
|
tem mais resultados
|
hasMoreResults | boolean |
EmailSummaryResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Resumo do email
|
value | array of EmailSummary |
Vendas de chaves |
|
tem mais resultados
|
hasMoreResults | boolean |
KeySalesResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Vendas de chaves'
|
value | array of KeySales |
Vendas de chaves |
|
tem mais resultados
|
hasMoreResults | boolean |
DocumentRecordListResponseEnvelope
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Registros relacionados
|
value | array of DocumentRecord |
Registros relacionados |
|
tem mais resultados
|
hasMoreResults | boolean |
CreateEnvelopeResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Envelope Id
|
envelopeId | string |
A ID do envelope. |
|
ID do modelo
|
templateId | string |
A ID do modelo. |
|
Situação
|
status | string |
O status do envelope. |
|
Data e hora do status
|
statusDateTime | string |
O datetime em que o status foi definido. |
|
URI
|
uri | string |
O URI do envelope em DocuSign. |
ListRecipientsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Signatários
|
signers | array of Signer |
Signatários |
Guia
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome da guia
|
name | string |
O nome da guia. |
|
Tipo de guia
|
tabType | string |
O tipo da guia. |
|
Rótulo da Guia
|
tabLabel | string |
O rótulo da guia. |
|
Valor da guia
|
value | string |
O valor da guia. |
|
ID da Guia
|
tabId | string |
A ID da guia. |
|
ID do documento
|
documentId | string |
A ID do documento. |
|
ID do destinatário
|
recipientId | string |
A ID do destinatário. |
|
É pré-arquivo
|
prefill | boolean |
Indica se a guia é do tipo prefill. |
|
Selecionado
|
selected | string |
Se as guias estiverem na caixa de seleção, indicará se a guia está selecionada. |
RecipientTabsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Guia Destinatário:
|
recipientTabs | array of Tab |
Guia Destinatário |
Signatário
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Ordem de Assinatura
|
routingOrder | string |
A ordem de assinatura do destinatário no documento. |
|
Função
|
roleName | string |
A função do signatário. |
|
ID do destinatário
|
recipientId | string |
A ID do destinatário. |
|
Nome
|
name | string |
O nome do destinatário. |
|
Email
|
string |
O email do destinatário. |
|
|
Tipo de destinatário
|
recipientType | string |
O tipo do destinatário. |
|
Tipo de verificação
|
verificationType | string |
O tipo de verificação. |
|
Guid do destinatário
|
recipientIdGuid | string |
O Guid do destinatário. |
GetLoginAccountsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Contas de logon
|
loginAccounts | array of LoginAccount |
Contas de logon |
LoginAccount
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome da conta. |
|
Guia de ID da conta
|
accountIdGuid | string |
O GUID da conta. |
ListTabsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Guias
|
tabs | array of Tab |
Guias |
ListEnvelopeDocumentFieldsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campo Personalizado
|
envelopeDocumentFields | array of EnvelopeDocumentField |
Documentar campos personalizados |
DocGenFormFieldsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Campos docgen
|
docgenFields | array of DocGenFormField |
Campos docgen |
DocGenFormField
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
documentId | string |
ID do documento. |
|
Etiqueta
|
label | string |
Etiqueta. |
|
Tipo
|
type | string |
Tipo. |
|
Nome
|
name | string |
Nome.. |
|
Value
|
value | string |
Valor. |
ListTemplatesResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Modelos de envelope
|
envelopeTemplates | array of EnvelopeTemplate |
Os modelos de envelope disponíveis. |
EnvelopeTemplate
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do modelo
|
templateId | string |
A ID do modelo. |
|
Nome
|
name | string |
O nome do modelo. |
BulkSendListGuid
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Guia lista de envio em massa
|
listId | string |
Guia de lista de envio em massa |
EnvelopeCustomFieldResponse
| Nome | 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 do envelope. |
|
Nome
|
name | string |
O nome do campo personalizado do envelope. |
|
Value
|
value | string |
O valor do campo personalizado do envelope. |
UpdateEnvelopeCustomFieldResponse
| Nome | 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 do envelope. |
|
Nome
|
name | string |
O nome do campo personalizado do envelope. |
|
Value
|
value | string |
O valor do campo personalizado do envelope. |
ListDocumentsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos de envelope
|
envelopeDocuments | array of EnvelopeDocument |
Os documentos anexados ao envelope. |
ListTemplateDocumentsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos de modelo
|
templateDocuments | array of EnvelopeDocument |
Documentos anexados a um modelo. |
AddDocumentsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Envelope Id
|
envelopeId | string |
A ID do envelope. |
|
Documentos de envelope
|
envelopeDocuments | array of EnvelopeDocument |
Os documentos anexados ao envelope. |
AddRecipientTabsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Guias do destinatário
|
recipientTabs | array of RecipientTab |
As guias adicionadas a um destinatário. |
EnvelopeDocument
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome do documento. |
|
ID do documento
|
documentId | string |
A ID do documento. |
|
Guid de documento
|
documentIdGuid | string |
O guid do documento. |
RecipientTab
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID da Guia
|
tabId | string |
A ID da guia. |
|
Tipo de guia
|
tabType | string |
O tipo da guia. |
EnvelopeDocumentField
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome do campo personalizado. |
|
Value
|
value | string |
O valor do campo personalizado. |
DeclineReasonWithoutType
objeto
Esse é o tipo 'object'.