Criar Modelo

Nossa API disponibiliza a criação de modelos para serem utilizados posteriormente nos contratos.

POST /templates

Clique aqui para testar endpoint

🚧

Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}',
  'Content-Type': 'application/json'
}

Exemplo de payload:

{
    "template": {
       "title": "Modelo API Contraktor",
       "description": "Descrição do modelo",
       "read_only_instances": false
    }
}

Descrição do payload:

NameTypeDescription
titlestringtítulo do modelo
descriptionstringdescrição do modelo
read_only_instancesbooleanse o valor para essa variável for true, ficará bloqueada a opção de edição do conteúdo dos contratos criados a partir desse modelo

⚠️ É importante salientar que o conteúdo do modelo deve ser inserido via editor na plataforma da Contraktor, assim como o incremento dos campos variáveis. O endpoint acima listado, cuidará apenas de criar o modelo, sem conteúdo prévio.

Exemplo de resposta:

{
    "data": {
        "content": null,
        "description": "Descrição do modelo",
        "editor": "tinymce",
        "forms": [],
        "html": null,
        "id": 2829,
        "inserted_at": "2024-06-04T16:50:22",
        "json_data": null,
        "organization": {
            "active": true,
            "addons": [],
            "available_proof_engines": [
                "standard"
            ],
            "domains": [],
            "id": 1199,
            "inserted_at": "2023-12-15T19:35:45",
            "logo_url": null,
            "name": "CK API Development Corp",
            "organization_plan": null,
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-06-04T12:19:52",
            "workflows": null
        },
        "read_only_instances": true,
        "title": "Modelo API Contraktor Título",
        "updated_at": "2024-06-04T16:50:22"
    }
}

Como utilizar modelos na Contraktor?

Acesse nossa central de ajuda e veja o passo a passo completo:

Criando um modelo com campos dinâmicos