# Crear documento via Plantilla

## Crear documento via Plantilla

<mark style="color:green;">`POST`</mark> `https://api.zapsign.com.br/api/v1/models/create-doc/`

Este endpoint te permite crear un documento a través de una **Plantilla DOCX**. Solo necesitas enviar los datos que van a reemplazar los campos dinámicos de la plantilla en formato JSON, y recibirás la respuesta también en JSON.

{% hint style="info" %}
Antes de iniciar debes crear la Plantilla con el endpoint [Crear plantilla DOCX](https://docs.zapsign.com.br/espanol/plantillas/create-template-docx) o crearla en la plataforma web de ZapSign en la sección de Plantillas y seleccionar la opción DOCX (**no esta disponible para plantillas PDF**). [Ver tutorial](https://www.youtube.com/watch?v=4RbglTOK23E) para crear una plantilla dinámica
{% endhint %}

#### Encabezado

<table><thead><tr><th width="175">Nombre</th><th width="103">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td>Authorization<mark style="color:red;">*</mark></td><td>string</td><td>API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23</td></tr></tbody></table>

#### Request Body

<table><thead><tr><th width="205">Nombre</th><th width="138">Tipo</th><th>Descripción</th></tr></thead><tbody><tr><td>template_id<mark style="color:red;">*</mark></td><td>string</td><td><p>El identificador/token de la plantilla dinámica. </p><p>Ejemplo: https://app.zapsign.co/conta/modelos/{TEMPLATE_ID} </p><p>Para acceder a tu lista de plantillas, <a href="https://app.zapsign.co/conta/modelos">haz clic aquí.</a></p></td></tr><tr><td>signer_name<mark style="color:red;">*</mark></td><td>string</td><td>El nombre del firmante (obligatorio). Si hay más de un firmante, puedes agregarlos más tarde usando el endpoint "<a href="../firmantes/adicionar-signatario">Adicionar firmante</a>".</td></tr><tr><td>signer_email</td><td>string</td><td>El correo electrónico del firmante. Si hay más de un firmante, puedes agregarlos más tarde. Si no defines el correo, el firmante deberá escribirlo durante la firma.</td></tr><tr><td>signer_phone_country</td><td>String</td><td>El indicativo de país del celular del firmante. Si hay más de un firmante, puedes agregarlos más tarde. </td></tr><tr><td>signer_phone_number</td><td>String</td><td>El número de celular del firmante. Si hay más de un firmante, puedes agregarlos más tarde. Si no defines el campo, el firmante deberá escribirlo durante la firma.</td></tr><tr><td>data[]['de']</td><td>string</td><td><p>La variable a reemplazar.</p><p>Ej: "{{Nombre completo}}"</p></td></tr><tr><td>data[]['para']</td><td>string</td><td>El valor con el que reemplazar la variable. Ej: "John Doe"</td></tr><tr><td>signer_has_incomplete_fields</td><td>bolean</td><td>Si se establece como <code>true</code>, el firmante será redirigido a completar el formulario de la plantilla antes de firmar el documento.<br>Por defecto: <code>false</code>.</td></tr><tr><td>lang </td><td>string</td><td><p>Idioma del documento. Posibles valores:</p><p>"pt-br" (portugués), "es" (español), "en" (inglés), "fr" (francés)</p><p>Por defecto: "pt-br"</p></td></tr><tr><td>disable_signer_emails </td><td>boolean</td><td>Si deseas desactivar todos los correos electrónicos enviados a los firmantes, envía este parámetro como true. Por defecto: false</td></tr><tr><td>brand_logo</td><td>string</td><td><p>Para personalizar la experiencia de firma y los correos enviados por ZapSign, envia el logo en una URL pública.</p><p>Valor por defecto: ""</p></td></tr><tr><td>brand_primary_color </td><td>string</td><td>Para personalizar la experiencia de firma y los correos enviados por ZapSign, envia el color de los botónes en este parámetro en formato rgb orhexadecimal. Ej: "#0011ee". Valor por defecto: ""</td></tr><tr><td>brand_name</td><td>string</td><td>Para personalizar el remitente de los correos, envia el nombre de tu marca en este parámetro. Por ejemplo, si escribes "Empresa ABC", el firmante recibirá el correo "Empresa ABC via ZapSign". Máximo de 100 carácteres. Valor por defecto: ""</td></tr><tr><td>external_id </td><td>string</td><td><p>Identificar del documento en tu aplicación.</p><p>Valor por defecto: ""</p></td></tr><tr><td>folder_path</td><td>string</td><td><p>Especifica la ruta de la carpeta dentro de ZapSign donde se guardará el documento. Si las carpetas no existen, se crearán automáticamente.</p><p>Ej.: "/api/" o "/folder1/folder2/folder3/".</p><p>Valor por defecto: "/" (sin folder).</p></td></tr><tr><td>created_by</td><td>string</td><td><p>Correo electrónico del usuario que se definirá como creador del documento, con fines organizativos internos. Si el correo no existe o no es un usuario de tu cuenta, este parámetro se ignorará.</p><p>Valor por defecto: "" (el dueño del documento será el propietario de la cuenta).</p></td></tr><tr><td>send_automatic_email </td><td>boolean</td><td>Si se establece en true, ZapSign enviará automáticamente un correo al firmante con el enlace para firmar el documento. Por defecto es false</td></tr><tr><td>send_automatic_whatsapp</td><td>boolean</td><td><p>Si se establece en true, ZapSign enviará automáticamente un mensaje por WhatsApp al firmante con el enlace para firmar el documento. Tiene un costo adicional de $0,1 USD (5 créditos)</p><p>Por defecto es false</p></td></tr><tr><td>custom_message</td><td>string</td><td><p>(se aplica a <strong>send_automatic_email: true</strong> y <strong>send_automatic_whatsapp: true</strong>). </p><p>Si <strong>send_automatic_email</strong> es <strong>true</strong> o <strong>send_automatic_whatsapp</strong> es <strong>true</strong>, puedes personalizar el mensaje del correo enviado al firmante. Ejemplo: "Hola [Nombre], \n Este es tu contrato de empleo. \n Saludos, Equipo XPTO". El símbolo \n sirve para saltos de línea.</p></td></tr><tr><td>reminder_every_n_days</td><td>integer</td><td><p>Intervalo de días entre recordatorios que se enviarán a los firmantes, mientras no hayan firmado el documento. El máximo son 6 intentos de recordatorio.</p><p>Obs: Este campo solo aplica si send_automatic_whatsapp o send_automatic_email están activados. Ejemplo: Si se establece en 8, se enviará un recordatorio cada 7 días.</p></td></tr><tr><td>allow_refuse_signature</td><td>boolean</td><td><p>Si se establece en true, los firmantes tendrán la opción de rechazar la firma.</p><p>Valor por defecto: false.</p></td></tr><tr><td>disable_signers_get_original_file</td><td>boolean</td><td><p>Si se establece en true, los firmantes no podrán descargar el documento original.</p><p>Valor por defecto: false.</p></td></tr><tr><td>send_automatic_whatsapp_signed_file</td><td>boolean</td><td><p>Si se establece en true, ZapSign enviará un mensaje por WhatsApp al firmante con el enlace al documento firmado. Recuerda que se deben tener créditos para enviar por WhatsApp (costo de $0,1 USD). </p><p>Por defecto es false</p></td></tr><tr><td>Metadata</td><td>Array</td><td>Metadatos personalizados enviados durante la creación del documento, en formato de pares <code>key</code> y <code>value</code>. Esta información solo aparece en los webhooks de creación, firma, rechazo y eliminación.</td></tr><tr><td>folder_token</td><td>string</td><td><p>Si se proporciona, este campo tendrá prioridad sobre <code>folder_path</code>. Define el directorio basado en el <strong>token de la carpeta</strong>, que se puede obtener accediendo a:<br><code>https://app.zapsign.com.br/conta/documentos?pasta=&#x3C;folder_token></code></p><p>Si aún no conoces el token, navega hasta la carpeta deseada a partir de:<br><code>https://app.zapsign.com.br/conta/documentos</code><br>y copia el valor del parámetro <code>pasta</code> en la URL después de abrir la carpeta.</p></td></tr><tr><td>signature_placement</td><td>string</td><td><p>Permite posicionar la firma en el documento usando un texto ancla (sin necesidad de coordenadas x, y). Configure signature_placement: "&#x3C;&#x3C;{identificador_de_firma}>>" y la firma será posicionada donde encuentre ese texto. Si el texto aparece más de una vez, la firma será posicionada en todas las ubicaciones. </p><p></p><p><strong>Nota</strong>: el uso de <mark style="color:$danger;"><strong>&#x3C;&#x3C; >></strong></mark> es altamente recomendado para evitar conflictos con el texto, pero no es obligatorio. Ej: "&#x3C;>". Default: "". Si no desea que el texto ancla sea visible en el documento final, basta con definir el color del texto ancla igual al color de fondo del documento.</p></td></tr><tr><td>rubrica_placement</td><td>string</td><td><p>Permite posicionar la rúbrica en el documento usando un texto ancla (sin necesidad de coordenadas x, y). Configure rubrica_placement: "&#x3C;&#x3C;{identificador_de_rubrica}>>" y la rúbrica será posicionada donde encuentre ese texto. Si el texto aparece más de una vez, la rúbrica será posicionada en todas las ubicaciones. </p><p></p><p><strong>Nota</strong>: el uso de <mark style="color:$danger;"><strong>&#x3C;&#x3C; >></strong></mark> es altamente recomendado para evitar conflictos con el texto, pero no es obligatorio. Ej: "&#x3C;>". Default: "". Si no desea que el texto ancla sea visible en el documento final, basta con definir el color del texto ancla igual al color de fondo del documento.</p></td></tr></tbody></table>

{% tabs %}
{% tab title="200 Template created successfully." %}

```json
{
    "open_id": 5,
    "token": "eb9c367a-e62f-4992-8360-b0219deaeecc",
    "status": "pending",
    "name": "Contracto de trabajo",
    "original_file": "https://zapsign.s3.amazonaws.com/pdf/62xxxxx-d8fc-4392-8575-f3c46c3cfc7a/df6bac91-2766-4182-8c8b-ded5287e4c0f.pdf",
    "signed_file": null,
    "created_at": "2020-04-16T03:33:46.241747Z",
    "last_update_at": "2020-04-16T03:33:46.241775Z",
    "signers": [
        {
            "token": "921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "sign_url": "https://app.zapsign.com.br/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "status": "new",
            "name": "Maria Perez",
            "email": "",
            "phone_country": "",
            "phone_number": "",
            "times_viewed": 0,
            "last_view_at": null,
            "signed_at": null
        }
    ],
    "answers": [ // list of variables and responses in the dynamic model (if the document was created using a dynamic model).
        {
            "variable": "Nombre completo",
            "value": "Maria Perez"
        },
        {
            "variable": "Documento de identidad",
            "value": "111.111.111"
        }
    ]
}
```

{% endtab %}
{% endtabs %}

### Request

{% embed url="<https://www.postman.com/zapsign/workspace/zapsign-workspace/request/27495556-11b56f17-c3cd-4898-bd58-98bcb011b925?ctx=documentation>" %}
URL for postman Create doc from Template endpoint
{% endembed %}

### Response

Después de una solicitud exitosa, recibirás una respuesta similar a esta:

{% hint style="warning" %}
**Advertencia**: los enlaces original\_file y signed\_file son temporales y caducan en 60 minutos. Si tu sistema necesita guardar esos enlaces, se recomienda almacenarlos en tu propio CDN o llamar al endpoint de[ Detalle del documento](https://docs.zapsign.com.br/espanol/documentos/detalhar-documento) cada vez que tu usuario necesite una URL válida que caduque en más de 60 minutos.
{% endhint %}

```javascript
{
    "open_id": 5,
    "token": "eb9c367a-e62f-4992-8360-b0219deaeecc",
    "status": "pending",
    "name": "Contrato de trabajo",
    "original_file": "https://zapsign.s3.amazonaws.com/pdf/62xxxxx-d8fc-4392-8575-f3c46c3cfc7a/df6bac91-2766-4182-8c8b-ded5287e4c0f.pdf",
    "signed_file": null,
    "created_at": "2020-04-16T03:33:46.241747Z",
    "last_update_at": "2020-04-16T03:33:46.241775Z",
    "signers": [
        {
            "token": "921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "sign_url": "https://app.zapsign.co/verificar/921c115d-4a6e-445d-bdca-03fadedbbc0b",
            "status": "new",
            "name": "Maria Perez",
            "email": "",
            "phone_country": "",
            "phone_number": "",
            "times_viewed": 0,
            "last_view_at": null,
            "signed_at": null,
            "resend_attempts": null
        }
    ],
    "answers": [
        {
            "variable": "FULL NAME",
            "value": "Foo bar"
        },
        {
            "variable": "SOCIAL SECURITY NUMBER",
            "value": "999-99-XXXX"
        },
        {
            "variable": "FULL ADDRESS",
            "value": "2989 Heller Crossing Apt. 023 - Springfield, NY / 13347"
        }
    ]
}
```

### Link de firma

En la respuesta de la solicitud, cada firmante va a tener un singer\_url que es el link para que firmen el documento. Si no enviaste el documento por los canales de ZapSign (`send_automatic_email` o `send_automatic_whatsapp`) debes enviar el enlace a los firmantes.

### ¿Más de un firmante?

{% hint style="info" %}
Si quieres adicionar más firmantes, después de crear el documento con este Endpoint usa el endpoint [Adicionar firmante](https://docs.zapsign.com.br/espanol/firmantes/adicionar-signatario) para configurar los otros firmantes.&#x20;
{% endhint %}

### ¡Habla con Gepeto!

¿Tienes alguna duda? Usa nuestra inteligencia artificial entrenada con toda la documentación de la API =)

{% embed url="<https://n8n.zapsign.com.br/webhook/fee2c476-7f23-4a4f-8928-5c7ab081ffcd/chat>" %}