PLplugsign

POST Create lote request

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.

post/api/lotes/requestsss

Request

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

Request body

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

lote_idinteger required

Id do lote que será usado para criar o lote request

emailstring[] required

E-mails para envio, mínimo 1

senderinteger

Id do colaborador que está enviando este documento, caso não seja passado, o documento será enviado pela conta do admin da empresa

subjectstring

Assunto enviado no e-mail

messagestring required

Mensagem enviada para o destinatário

expire_datestring

Deve ser uma data válida no formato Y-m-d H:i:s e posterior ao momento atual

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_modeboolean

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

Response

200

messagestring

Example response

{
  "data": [
    {
      "id": 1,
      "signing_key": "dagQ9dfs3asWA1dXXKCv4p2Udn352DSs",
      "email": "contato@exemplo.com",
      "message": "Segue para assinatura",
      "sender": 12,
      "send_time": "19/09/2024 09:49:24",
      "update_time": "01/10/2024 09:36:47",
      "created_at": "19/09/2024 09:49:24",
      "status": "Pending",
      "lote_id": 3,
      "url": "https://app.plugsign.com.br/view/lote/321?signingKey=dagQ9dfs3asWA1dXXKCv4p2Udn352DSs"
    }
  ],
  "message": "Sua solicitação foi enviada com sucesso!"
}

Changes