Create Sign Request

Compatibilidade do projeto

Windows | Multiplataforma

Visão geral

Description	Método do API	Caminho da API
Criar uma solicitação de assinatura para um documento usando um modelo Box Sign.	Postar	/sign_requests/send

Observação:

Para criar uma solicitação de assinatura com a atividade Create Sign Request, os documentos usados no processo devem ter tags de modelo.

As tags de modelo são uma maneira de adicionar dados a um documento base que o Box Sign reconhece automaticamente. Para saber como criar modelos usando tags, consulte a documentação oficial do Box.

Entrada

Parâmetro	Description	Tipo de dados
Emails do signatário	Os endereços de e-mail de todos os signatários necessários. A ordem dos signatários pode ser especificada, com o primeiro signatário designado como índice 0.	String
Arquivo a assinar	O arquivo para o qual a solicitação de assinatura está sendo criada.	lista de dados
Pasta de destino	A pasta em que o documento assinado será salvo depois de concluído.	lista de dados
Modelo	O modelo Box Sign a ser usado no processo de assinatura. Os modelos podem ser criados diretamente dentro do Box.	lista de dados
Assunto do e-mail	A linha de assunto do e-mail de solicitação de assinatura enviado aos destinatários.	String
MensagemDoEmail	O corpo da mensagem incluída no e-mail enviado aos signatários.	String
Lembretes	Se habilitada, a Box enviará automaticamente lembretes para os signatários pendentes nos dias 3, 8, 13 e 18.	Booleano
Dias válidos	O número de dias após os quais a solicitação de assinatura expirará automaticamente se não for concluída.	Int32
As assinaturas de texto estão habilitadas	Determina se os signatários podem assinar digitando seus nomes (assinaturas de texto). Se desabilitada, somente assinaturas desenhadas ou carregadas são permitidas.	Booleano
ID Externo	Um identificador usado para fazer referência à solicitação de assinatura em um sistema externo.	String
Valor de texto das tags de pré-preenchimento	O valor de texto para preencher previamente uma tag de texto correspondente definida no modelo.	String
Valor de data das tags de preenchimento prévio	Um valor de data usado para preencher previamente uma tag de data definida no modelo.	DateTime
É necessária preparação de documento	Indica se a preparação do documento (por exemplo, configuração de campos) é necessária antes do envio.	Booleano
Valor da caixa de seleção de tags pré-preenchidas	Um valor booleano usado para preencher previamente um campo de caixa de seleção no modelo.	Booleano
ID da tag de documento de tags de pré-preenchimento	O ID da tag do campo que está sendo pré-preenchido, conforme definido no modelo Box Sign.	String

Observação:

As tags de modelo são atribuídas na ordem em que os endereços de e-mail são adicionados ao campo E-mails do signatário . Esta não é a mesma que a ordem de assinatura. Se houver mais tags no documento do que signatários reais, essas tags não serão preenchidas. Se você adicionar mais signatários do que tags, os signatários extras podem assinar o documento, mas não serão direcionados para os locais no documento. Eles podem adicionar texto, datas e assinaturas onde desejarem no documento.

Saída

Parâmetro	Description	Tipo de dados
ID da solicitação de assinatura	O identificador exclusivo da solicitação de assinatura recém-criada.	String
Create Sign Request	O objeto de resposta completo detalhando a solicitação de assinatura criada.	object

Observação:

• Nos fluxos de trabalho de API, um único objeto de resposta é retornado como a saída. Quaisquer campos necessários podem ser extraídos diretamente deste objeto.
• Em fluxos de trabalho de RPA, alguns parâmetros de saída podem diferir, mas os valores necessários ainda podem ser recuperados do objeto de resposta, mesmo que não estejam explicitamente expostos.