POST Upload template

Changed on Nov 3, 2026

Com este endpoint você poderá enviar um novo template ao sistema, para futuramente enviar solicitações de assinatura para várias pessoas de forma simplificada.Campos do template: informe <code>width_page</code> (largura da página em pixels) e <code>fields[]</code> com a posição de cada campo (<code>input</code> image para assinatura ou text para texto; <code>page</code>, <code>width</code>, <code>height</code>, <code>xPos</code>, <code>yPos</code> e, para text, <code>text</code>, <code>color</code> e <code>fontsize</code>). Sem esses campos o template é criado sem posições e <code>POST /api/requests/templates</code> responde 422 ("Este template não possui campos definidos").Regras: formatos aceitos pdf, doc, docx, xls e xlsx; <code>file</code> como arquivo (multipart/form-data) ou base64 com data URI (apenas PDF); <code>pass_owner</code> e <code>pass_user</code> em par e não aceitos para Word; a resposta tem o mesmo formato de <code>POST /api/files/upload</code> (inclui <code>tags</code>, <code>editablevalidate</code> e <code>pdf_optimization</code>).

post/api/files/upload/template

Request

Base URL
https://app.plugsign.com.br
URL
https://app.plugsign.com.br/api/files/upload/template
Auth
API key in header Authorization

Request body

folderinteger

ID da pasta onde o documento deve ser armazenado. Caso não seja informado, o documento ficará na pasta raiz da empresa.

departmentsinteger[]

Departamento(s) o qual o documento deve pertencer.

accessibility'Everyone' | 'Departments' | 'OnlyMe'

Visibilidade padrão do documento.

namestring required

Nome único do documento para visualização no front-end.

filestring binary required

Arquivo PDF, DOC, DOCX, XLS ou XLSX (multipart/form-data) ou string base64 com data URI (apenas PDF).

pass_ownerstring

Senha do proprietário do PDF. Obrigatória quando pass_user é enviada; não aceita para Word.

pass_userstring

Senha de abertura do PDF. Obrigatória quando pass_owner é enviada; não aceita para Word.

optimizerboolean

Marca o documento para otimização, caso enviado 1 o sistema irá otimizar e achatar campos de formulário no documento.

uploaded_byinteger

ID do usuário que enviou o documento.

editablevalidateinteger

Tipo de validação padrão ao assinar um documento. 7 - QR Code (Texto) na lateral direita. 6 - QR Code (Texto) na lateral esquerda. 5 - Página final de validação e QR Code no cabeçalho (Criaremos páginas extras). 4 - QR Code no rodapé do documento (Sem página final). 3 - Página final de validação e QR Code. 2 - Sem QR Code no topo, apenas página no final. 1 - QR Code no topo do documento (Sem página final). Ao solicitar a assinatura na última página, sem posicioná-la, a página final será sempre gerada automaticamente

width_pagenumber

Largura da página em pixels usada para calcular as posições de fields[].

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "data": {
    "id": 182151,
    "name": "teste-template",
    "file_name": "lT5rX42RNCCoSXbv1X4KjQzVUSU7F8hx.pdf",
    "extension": "pdf",
    "size": 14639,
    "status": "Unsigned",
    "document_key": "lT5rX42RNCCoSXbv1X4KjQzVUSU7F8hx",
    "editted": "No",
    "is_template": "Yes",
    "template_fields": "[\"200\",{\"xPos\":\"10\",\"yPos\":\"30\",\"input\":\"image\",\"width\":\"200\",\"height\":\"120\",\"page\":\"2\"},{\"input\":\"text\",\"xPos\":\"122\",\"yPos\":\"324\",\"width\":\"200\",\"height\":\"120\",\"page\":\"3\",\"fontsize\":\"14\",\"text\":\"meu texto\",\"color\":\"#404034\"}]",
    "accessibility": "Departments",
    "folder": "Source",
    "uploaded_by": {
      "name": "Sua Empresa",
      "last_name": "Assinaturas"
    },
    "uploaded_on": "20/11/2023 19:56:41",
    "download": "https://app.plugsign.com.br/api/files/download/lT5rX42RNCCoSXbv1X4KjQzVUSU7F8hx",
    "editablevalidate": 1
  },
  "message": "Upload efetuado com sucesso!"
}

Changes

Nov 3, 20263db1513040ea Revision changes
- info
  added the new optional request property
- info
  added the new optional 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

Operation history