---
title: "POST Upload template"
method: POST
path: "/api/files/upload/template"
---

# POST Upload template

`POST /api/files/upload/template`

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.

## Request body

- object
  - `folder` integer — ID da pasta onde o documento deve ser armazenado. Caso não seja informado, o documento ficará na pasta raiz da empresa.
  - `departments` integer[] — Departamento(s) o qual o documento deve pertencer.
  - `accessibility` 'Everyone' | 'Departments' | 'OnlyMe' — Visibilidade padrão do documento.
  - `name` string, required — Nome único do documento para visualização no front-end.
  - `file` string, binary, required — [File/String Base64] Arquivo que está sendo enviado em PDF (File ou Base64), Word, Excel ou Power Point. (Para Base64 utilizar o formato data:application/pdf;base64)
  - `pass_owner` string — Senha do propietário do documento com permissões totais.
  - `pass_user` string — Senha de acesso simples do documento.
  - `optimizer` boolean — Marca o documento para otimização, caso enviado 1 o sistema irá otimizar e achatar campos de formulário no documento.
  - `uploaded_by` integer — ID do usuário que enviou o documento.
  - `editablevalidate` integer — Tipo de validação padrão ao assinar um documento. <br><br> 7 - QR Code (Texto) na lateral direita. <br><br> 6 - QR Code (Texto) na lateral esquerda. <br><br> 5 - Página final de validação e QR Code no cabeçalho (Criaremos páginas extras). <br><br> 4 - QR Code no rodapé do documento (Sem página final). <br><br> 3 - Página final de validação e QR Code. <br><br> 2 - Sem QR Code no topo, apenas página no final. <br><br> 1 - QR Code no topo do documento (Sem página final). <br><br> Ao solicitar a assinatura na última página, sem posicioná-la, a página final será sempre gerada automaticamente

## Response `200`

200

- object
  - `data` object — Objeto contendo os dados do template enviado.
    - `id` integer — Identificador único do arquivo.
    - `name` string — Nome do template na plataforma.
    - `file_name` string — Nome físico do arquivo no sistema.
    - `extension` string — Extensão do arquivo (ex: pdf).
    - `size` integer — Tamanho do arquivo.
    - `status` string — Status atual do arquivo.
    - `document_key` string — Chave única de identificação do documento.
    - `editted` 'Yes' | 'No' — Indica se o documento já foi editado.
    - `is_template` string — Indica se o documento é um template. Sempre Yes para este endpoint.
    - `template_fields` string — JSON serializado contendo os campos de preenchimento e assinatura definidos no template.
    - `accessibility` 'Everyone' | 'Departments' | 'OnlyMe' — Define quem pode acessar o documento.
    - `departments` string — Departamentos com acesso ao documento.
    - `folder` string — Nome da pasta onde o template está armazenado.
    - `uploaded_by` object — Objeto com os dados do usuário que enviou o template.
      - `name` string — Nome do usuário que enviou o template.
      - `last_name` string — Sobrenome do usuário que enviou o template.
    - `uploaded_on` string — Data e hora em que o template foi enviado, no formato DD/MM/AAAA HH:mm:ss.
    - `download` string — URL para download do template.
  - `message` string — Mensagem de confirmação retornada pela API.

---

[API](https://skmtc.net/plugsign/apis/endpoints-manuais.md) · [All operations](https://skmtc.net/plugsign/apis/endpoints-manuais/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plugsign/endpoints-manuais/revisions/41e10c7c691b/schema)