Update template
By using this endpoint with the model token, you can update data such as the model's name and language. It is also possible to toggle its state between enabled and disabled. Redefine the emails of contacts who will be notified about the model. And finally, edit configuration fields for the first signer defined in the model.
Update template
PUThttps://api.zapsign.com.br/api/v1/templates/{{template_token}}/
In the above endpoint, replace {{template_token}} with the unique token of the model you want to update.
Headers
Authorization*
string
apiToken ahead of the "Bearer" text.
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
Request Body
name
string
Title of the document. String of up to 255 characters
lang
string
Document language. Possible values: "pt-br" (Portuguese), "es" (Spanish), "en" (English), "fr" (French). Default: "pt-br"
active
boolean
This field is used to control the visibility and usage status of the document in the application.
observers
array<string>
Represents document observers (limit 20), i.e. email addresses that will be notified upon completion of the signature flow. It's an array of strings.
first_signer
Object
Document signer configuration
folder_token
string
If provided, this field will take precedence over folder_path. It defines the directory based on the folder token, which can be obtained by accessing: https://zapsign.com.br/conta/modelos?pasta=<folder_token> If you don’t know the token yet, navigate to the desired folder starting from: https://zapsign.com.br/conta/modelos Then, copy the pasta parameter from the URL after opening the target folder.
folder_path
string
Path of the folder inside ZapSign where the template will be placed. If the folders do not exist, they will be created automatically. Requirements: folder_path can be up to 255 characters long Each folder can be up to 50 characters long There is a limit of 5 folder levels Example: /api/ or /folder1/folder2/folder3/ Default value: / (no folder)
The parameter url_docx or base64_docx cannot be changed. If you need to modify the document of the model, a new model will need to be created.
Configuring the Signer
These fields allow you to adjust the signing experience, such as the authentication method.
To learn more about the signer configuration fields, visit the model creation page.
Request
{
"name": "Template name",
"lang": "en",
"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": "Signer"
}
}Response
{
"token": "152f8416-xxxx-xxxx-xxxx-1aaf785dd335",
"template_type": "docx",
"name": "Template name",
"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": "en"
"signers": [
{
"name": "{{FULLNAME}}",
"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": "Signer"
}
],
"inputs": [
{
"variable": "{{FULLNAME}}",
"input_type": "input",
"label": "What is your fullname?",
"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": "CPF",
"help_text": "",
"options": "",
"required": false,
"order": 3
}
],
"extra_templates": [],
"notify_extra_emails": "[email protected]",
"custom_intro": "",
"youtube_video_code": ""
}Request
Last updated
Was this helpful?