👍
Modelos de documentos
Com esta funcionalidade, você poderá utilizar templates criados em Microsoft Word para criação automática de documentos baseados em metadados. Confira mais em nossa página de Ajuda.

📘
Requisição para a alteração de Modelo na Clicksign. Esta é uma requisição PATCH para api/v3/templates/{{template_id}}. No body, deverão ser enviados os atributos do template.

PATCH api/v3/templates/{{template_id}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

Tipo de dados

Atributo	Descrição	Obrigatório
`type`	Determina o tipo de dados, que aqui deve ser `templates`.	Sim
`id`	Número identificador do modelo, disponível na resposta gerada ao criar o modelo.	Sim

Atributos para criação do documento

Atributo Descrição Obrigatório Padrão Exemplo

name Nome do arquivo do documento a ser alterado. Sim Sem valor padrão Teste

Atributo	Descrição	Obrigatório	Padrão	Exemplo
`name`	Nome do arquivo do documento a ser alterado.	Sim	Sem valor padrão	Teste
`color`	A cor de identificação do template. As opções em formato hexadecimal são: `#1474F5` (azul), `#15D3C9` (azul-turquesa), `#05C412` (verde), `#FCCF00` (amarelo), `#F77C04` (laranja), `#CF2E58` (rosa-escuro), `#FF86D5` (rosa-claro), `#8726D9` (roxo) e `#577B8D` (cinza).	Sim	Sem valor padrão	15D3C9

color

A cor de identificação do template.

As opções em formato hexadecimal são: #1474F5 (azul), #15D3C9 (azul-turquesa), #05C412 (verde), #FCCF00 (amarelo), #F77C04 (laranja), #CF2E58 (rosa-escuro), #FF86D5 (rosa-claro), #8726D9 (roxo) e #577B8D (cinza).

Sim

Sem valor padrão

15D3C9

❗️
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.

Exemplo completo

Request

PATCH api/v3/templates/{{template_id}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

{
    "data": {
        "id": "79dbd22b-fcab-4cb4-87dc-b7ebfe2a7bd7",
        "type": "templates",
        "attributes": {
            "name": "Teste",
            "color": "#ff86d5"
        }
    }
}

Response

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

{
    "data": {
        "id": "79dbd22b-fcab-4cb4-87dc-b7ebfe2a7bd7",
        "type": "templates",
        "links": {
            "self": "https://3.clicksign.dev/api/v3/templates/79dbd22b-fcab-4cb4-87dc-b7ebfe2a7bd7",
            "files": {
                "original": "https://3.clicksign.dev/media/W1siZiIsIjIwMjMvMDgvMjIvMTQvMTkvMjUvN2I5N2I3MTItMDI0Yi00Yzc2LWE4N2UtZmE2NDcyMzAxMTQ5L2ZpbGUuZG9jeCJdXQ/file.docx?sha=e090d1501cdf78fd"
            }
        },
        "attributes": {
            "name": "Teste",
            "color": "#ff86d5",
            "created": "2023-08-22T11:19:25.743-03:00",
            "modified": "2023-08-22T11:46:35.778-03:00"
        }
    }
}