v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

PUT Update lote

Este endpoint permite que você edite as informações de um lote de forma rápida.

Ideal para ajustar dados antes do envio ou corrigir informações sem a necessidade de criar um novo lote.

put/api/lotes/{id}

Path parameters

idinteger required

Id do lote.

Request body

namestring required

Novo nome do lote.

filesinteger[]

Lista de ID's dos documentos vinculados ao lote.

Response

200

Example response

{
  "data": {
    "id": 3,
    "company_id": 731,
    "name": "lote-exemplo",
    "created_at": "2024-09-30 16:49:38",
    "updated_at": "2024-09-30 16:49:38",
    "lote_requests": [
      {
        "id": 3,
        "signing_key": "rBIIb25n8UA2FOZXfb1R2uoXfa3hlM28",
        "email": "contato@exemplo.com",
        "message": "teste",
        "sender": 1573,
        "send_time": "30/09/2024 16:55:02",
        "update_time": "30/09/2024 16:55:52",
        "created_at": "30/09/2024 16:55:02",
        "status": "Pending",
        "lote_id": 3,
        "url": "https://app.plugsign.com.br/view/lote/321?signingKey=rBIIb25n8UA2FOZXfb1R2uoXfa3hlM28"
      }
    ],
    "files": [
      {
        "id": 463494,
        "name": "lote-exemplo-1",
        "file_name": "dxww4du3D4N3z56UXD92rczIsadn3pEd.pdf",
        "extension": "pdf",
        "size": 13,
        "status": "Unsigned",
        "document_key": "d182jiQ3C6BCaARdzxQMi24uqMa4328",
        "editted": "Yes",
        "is_template": "No",
        "accessibility": "Everyone",
        "folder": "Source",
        "uploaded_by": {
          "name": "Empresa",
          "last_name": "Exemplo"
        },
        "uploaded_on": "30/09/2024 16:49:38",
        "download": "https://app.plugsign.com.br/api/files/download/d182jiQ3C6BCaARdzxQMi24uqMa4328",
        "editablevalidate": 3
      }
    ]
  }
}