Actualizar plantilla

Al utilizar este endpoint con el token de la plantilla, puedes actualizar los datos como el nombre y el idioma de la plantilla. También es posible alternar su estado entre activado y desactivado. Restablecer los correos electrónicos de los contactos que serán notificados sobre la plantilla. Y por último, editar los campos de configuración del primer firmante definido en la plantilla.

Actualizar plantilla

PUThttps://api.zapsign.com.br/api/v1/templates/{{template_token}}/

En el endpoint anterior, sustituye {{template_token}} por el token exclusivo de la plantilla que deseas actualizar.

Encabezado

Nombre	Tipo	Descripción
Authorization*	string	API token prefijo con la palabra "Bearer". Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23

Request Body

Name	Type	Description
name	string	Título de la plantilla máximo 255 caracteres.
lang	string	Idioma del documento Posibles valores: "pt-br" (Portugues), "es" (Español), "en" (Inglés), "fr" (Francés). Valor por defecto: "pt-br"
active	boolean	Este campo se utiliza para controlar el estado de visibilidad y uso del documento en la aplicación.
observers	array<string>	Representa a los observadores del documento (hasta 20 personas), es decir, direcciones de correo electrónico que serán notificadas cuando se firme un documento generado a partir de esta plantilla. Es un array de correos electrónicos.
first_signer	Object	Configuración del firmante del documento.
folder_token	string	Si se proporciona, este campo tendrá prioridad sobre folder_path. Define el directorio basado en el token de la carpeta, que se puede obtener accediendo a: https://zapsign.com.br/conta/modelos?pasta=<folder_token> Si aún no conoces el token, navega hasta la carpeta deseada a partir de: https://zapsign.com.br/conta/modelos y copia el valor del parámetro pasta en la URL después de abrir la carpeta.
folder_path	string	Especifica la ruta de la carpeta dentro de ZapSign donde se guardará el modelo. Si las carpetas no existen, se crearán automáticamente. Requisitos: folder_path puede tener hasta 255 caracteres Cada carpeta puede tener hasta 50 caracteres Hay un límite de 5 niveles de carpetas Ejemplo: /api/ o /carpeta1/carpeta2/carpeta3/ Valor predeterminado: / (sin carpeta)

El parámetro url_docx o base64_docx no puede ser modificado. Si necesitas cambiar el documento de la plantilla, será necesario crear una plantilla nueva.

Configurando el Firmante

Estos campos permiten ajustar la experiencia de firma, como el método de autenticación.

Para entender más sobre los campos de configuración del firmante, accede a la página de creación de plantilla.

Request

{
    "name": "Nombre de la plantilla",
    "lang": "es",
    "active": "true",
    "observers": [
        "[email protected]"
    ],
    "first_signer": {
        "blank_email": false,
        "blank_phone": false,
        "auth_mode": "assinaturaTela",
        "require_selfie_photo": false,
        "require_document_photo": false,
        "selfie_validation_type": "",
        "qualification": "Aprobador"
    }
}

Response

200: OK - Plantilla actualizada con éxito

{
	"token": "152f8416-xxxx-xxxx-xxxx-1aaf785dd335",
	"template_type": "docx",
	"name": "Nombre de la plantilla",
	"active": true,
	"template_file": "https://zapsign.s3.amazonaws.com/2022/1/docs/xxxxx-d66b-495f-9b51-xxxx.docx",
	"created_at": "2022-01-05T12:59:42.563218Z",
	"last_update_at": "2022-01-05T13:03:22.242003Z",
	"redirect_link": "",
	"folder_path": "",
	"lang": "es"
	"signers": [
		{
			"name": "{{NOMBRE COMPLETO}}",
			"auth_mode": "assinaturaTela",
			"email": "",
			"phone_country": "",
			"phone_number": "",
			"lock_name": true,
			"lock_phone": false,
			"lock_email": false,
			"hide_phone": false,
			"blank_phone": false,
			"hide_email": false,
			"blank_email": false,
			"require_selfie_photo": false,
			"require_document_photo": false,
			"selfie_validation_type": "none",
			"qualification": "Aprobador"
		}
	],
	"inputs": [
		{
			"variable": "{{NOMBRE COMPLETO}}",
			"input_type": "input",
			"label": "NOMBRE COMPLETO",
			"help_text": "",
			"options": "",
			"required": false,
			"order": 1
		},
		{
			"variable": "{{CNPJ}}",
			"input_type": "input",
			"label": "CNPJ",
			"help_text": "",
			"options": "",
			"required": false,
			"order": 2
		},
		{
			"variable": "{{CPF}}",
			"input_type": "input",
			"label": "CRO",
			"help_text": "",
			"options": "",
			"required": false,
			"order": 3
		}
	],
    "extra_templates": [],
    "notify_extra_emails": "[email protected]",
    "custom_intro": "",
    "youtube_video_code": ""
}

Ejemplo de una solicitud en Postman

List templates | ZapSign WorkspacePostman