📘
Requisição para a criação de modelos de documentos na Clicksign. Esta é uma requisição POST para /api/v2/templates. No body, deverão ser enviados os atributos do documento e do template.

🚧
Atenção
No método POST o atributo Content-Type deverá ter o valor multipart/form-data

Criando um modelo

POST /api/v2/templates?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: multipart/form-data
Accept: application/json

Atributos para criação do documento

Atributo	Descrição	Exemplo
`template[name]` Obrigatório	Nome que será dado ao modelo.	`template[name]='Template de contrato'`
`template[content]` Obrigatório	Upload do conteúdo NOTA: É necessário que o path termine com`.docx`.	@/path/to/template_contrato.docx
`template[color]` Opcional	Definição da cor do tag	`template[color]=#1474f5` Cores suportadas: #1474f5 #15d3c9 #05c412 #fccf00 #f77c04 #cf2e58 #ff86d5 #8726d9 #577b8d

Atributo

Descrição

Exemplo

template[name]

Obrigatório

Nome que será dado ao modelo.

template[name]='Template de contrato'

template[content]

Obrigatório

Upload do conteúdo

NOTA: É necessário que o path termine com.docx.

@/path/to/template_contrato.docx

template[color]

Opcional

Definição da cor do tag

template[color]=#1474f5

Cores suportadas:
#1474f5
#15d3c9
#05c412
#fccf00
#f77c04
#cf2e58
#ff86d5
#8726d9
#577b8d

Corpo do envio

{
    "key": "f8b5ab9e-0f9b-47f4-badf-8f01c03abdd3",
    "name": "teste_modelo",
    "color": "#1474f5",
    "created_at": "2021-08-17T15:34:15.720-03:00",
    "updated_at": "2021-08-17T15:34:15.720-03:00",
    "url": "https://app.clicksign.com/media/W1siZiIsIjIwMjEvMDgvMTcvMTgvMzQvMTUvMmU0NDllY2UtNGUyNC00YjgzLTg0MTAtOTQ2MzY5ODUxNDg1L0RvY3VtZW50b190ZXN0ZS5kb2N4Il1d/Documento_teste.docx?sha=95ee48ad2964023f"
}

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Consultando a lista de modelos

GET /api/v2/templates?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

{
    "templates": [
        {
            "key": "f8b5ab9e-0f9b-47f4-badf-8f01c03abdd3",
            "name": "teste_modelo",
            "color": "#1474f5",
            "created_at": "2021-08-17T15:34:15.720-03:00",
            "updated_at": "2021-08-17T15:34:15.720-03:00",
            "url": "https://app.clicksign.com/media/W1siZiIsIjIwMjEvMDgvMTcvMTgvMzQvMTUvMmU0NDllY2UtNGUyNC00YjgzLTg0MTAtOTQ2MzY5ODUxNDg1L0RvY3VtZW50b190ZXN0ZS5kb2N4Il1d/Documento_teste.docx?sha=95ee48ad2964023f"
        },
 }

Response

HTTP/1.1 201 Created
Content-Type: application/json; charset=utf-8