v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Send Lote Requests

Com esse método é possível enviar um lote de documentos para assinatura.

Com o uso de lotes, você pode agrupar e enviar vários documentos de uma só vez, otimizando o processo de coleta de assinaturas.

Ideal para fluxos em que múltiplos documentos precisam ser assinados simultaneamente por um ou mais participantes.

post/api/lotes/requests

Request body

lote_idinteger required

Lote ID usado na solicitação.

chainboolean

Se a solicitação é em cadeia, ou seja, deve respeitar a ordem dos e-mails para envio ou se será enviada para todos ao mesmo tempoo

senderstring

Identifica o colaborador que aparecerá como remetente deste documento. Pode ser o ID do usuário ou o e-mail dele. Se omitido, o documento será enviado pela conta do admin da empresa.

observerstring[]

Os observadores irão receber comunicados referentes à situação da solicitação. Para isso, inclua uma lista de emails

due_monthsstring

A validade do documento em meses, por exemplo, um contrato com 12 meses de validade. Nós iremos monitorar a data e avisaremos antes do vencimento, para que possam refazer a solicitação e reenviar para assinatura

silent_modeinteger

Quando ativado (True), o request não gera um e-mail para o cliente. Apenas o URL de assinatura e o e-mail serão retornados.

width_pagestring required

Largura da página em pixels, este número será utilizado na hora de calcular as posições e campos de solicitação e/ou assinatura

Response

200

messagestring

Mensagem de confirmação retornada pela API após o envio da solicitação.