O que são modelos?

Os Modelos (ou Templates) são ferramentas para simplificar e agilizar a criação de documentos de forma padronizada e reutilizável. Eles permitem a definição de um formato padrão para documentos específicos, o que facilita a geração de novos documentos com estrutura similar, economizando tempo e garantindo consistência em todos os seus processos de assinatura.

A funcionalidade de Modelos está disponível nos planos com API disponível

Crie um modelo

Utilize o endpoint de Criar Modelo para iniciar o processo de criação de um novo modelo. Neste endpoint, você poderá definir o nome do modelo, cor de identificação e o arquivo em si.

Edite um modelo

Se houver necessidade de realizar alterações nas configurações de um modelo existente, utilize o endpoint de Atualizar Modelo. No entanto, vale destacar que não é possível editar o conteúdo do arquivo do modelo diretamente. Caso precise alterar o conteúdo do documento, será necessário excluir o modelo atual e criar um novo.

A edição se limita a campos como nome, cor de identificação e outras configurações associadas ao modelo, como o uso de variáveis dinâmicas que permitem a personalização do documento em cada uso.

Exclua um modelo

Se você desejar excluir um modelo, utilize o endpoint de Excluir Modelo. A exclusão de um modelo pode ser necessária quando ele não for mais útil ou quando precisar ser substituído por um novo. Lembre-se de que, ao excluir um modelo, todas as suas instâncias associadas também serão removidas, e você precisará criar um novo modelo caso queira utilizar um formato semelhante.

Exemplo de fluxo de uso

Imagine que sua empresa utiliza um contrato de prestação de serviços padrão. Com o modelo, você cria o contrato uma vez, configurando campos como o nome do cliente, o valor do contrato e a data de início. Quando um novo cliente for assinar o contrato, basta preencher esses campos específicos e gerar o documento para assinatura. Isso economiza tempo e evita erros de digitação ou formatação.

Próximos passos

Desenvolvemos um guia passo a passo para realizar requisições utilizando cURL como demonstração: