PLplugsign

POST Send Lote Requests

Changed on

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.

Comportamentos importantes:

  • Se subject e message não forem informados no destinatário, valem os valores da raiz; sem nenhum dos dois, a mensagem padrão é Você foi convidado para assinar um lote de documentos.
  • certificate aqui é booleano (não há níveis 0 a 3 nem certificate_timestamp como no envio por documento).
  • fullname, cpf e birthdate não são validados pela API.
  • Se signature_type não existir, o papel do signatário fica null.
  • Formato legado, sem recipients: email[] e message obrigatórios, com subject, expire_date, due_months, chain e silent_mode opcionais.
post/api/lotes/requests

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/lotes/requests
  • Auth
    API key in header Authorization

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 tempo.

senderstring

Identifica o colaborador remetente da solicitação. Informe o ID do usuário ou o e-mail de um usuário pertencente à mesma empresa. Se omitido, utiliza o usuário autenticado.

String ou integer .

observerstring[]

Lista de e-mails dos observadores da solicitação. Os observadores recebem comunicações relacionadas ao andamento do processo de assinatura.

due_monthsinteger

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_modeboolean

Quando true, a solicitação é criada sem enviar notificações por e-mail, WhatsApp ou lembretes. A resposta retorna a lista silent_mode com a URL de assinatura e o contato de cada destinatário.

width_pagenumber

Largura da página em pixels, usada como referência de escala na hora de calcular as posições dos campos de assinatura e texto (<code>fields</code>).

<p>Campo opcional. Regras:</p> <ul> <li><strong>Com <code>width_page</code>:</strong> é necessário enviar <code>fields</code> com as posições dos campos.</li> <li><strong>Sem <code>width_page</code>:</strong> não envie <code>fields</code> — a assinatura será posicionada automaticamente em uma página final gerada automaticamente pelo sistema, ao fim do documento.</li> </ul>
subjectstring

Assunto padrão do e-mail, usado pelos destinatários que não informarem <code>subject</code>.

messagestring

Mensagem padrão, usada pelos destinatários que não informarem <code>message</code>. Padrão: "Você foi convidado para assinar um lote de documentos".

certificateboolean

Exige certificado digital de todos os destinatários (equivale a definir <code>recipients[].certificate</code> em cada um).

Response

200

messagestring

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

Changes

  • 3db1513040eaRevision changes
    • breaking

      request property //// was restricted to a list of enum values

    • breaking

      request property //// was restricted to a list of enum values

    • breaking

      request property //// was restricted to a list of enum values

    • breaking

      request property //// was restricted to a list of enum values

    • breaking

      request property //// was restricted to a list of enum values

    • breaking

      the request property type changed from string to integer

    • breaking

      the //// request property type changed from string to number

    • breaking

      the request property type changed from integer to boolean, and format from int32 to no format

    • breaking

      the request property type changed from string to number

    • warning

      the // request property's maxLength was set to 255

    • warning

      removed the request property ////

    • warning

      removed the request property ////

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property default value false was added

    • info

      added the new bold enum value to the request property ////

    • info

      added the new center enum value to the request property ////

    • info

      added the new italic enum value to the request property ////

    • info

      added the new left enum value to the request property ////

    • info

      added the new right enum value to the request property ////

    • info

      added the new strikethrough enum value to the request property ////

    • info

      added the new underline enum value to the request property ////

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status