Api token a frente do texto "Bearer".
Ex: Bearer c7f35c84-7893-4087-b4fb-d1f06c23
| #### Request Body | Name | Type | Description | | ---------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | template\_id\* | string |Identificador/token do template (modelo dinâmico)
Ex:
Para acessar a sua lista de templates clique aqui:
Nome da variável a ser substituída.
Ex: "{{NOME COMPLETO}}"
| | data\[]\['para'] | string | Valor a ser preenchido no lugar da variável. Ex: "João dos Santos" | | signer\_email | string | Email do signatário do documento. Se houver mais de um signatário no documento, você poderá adicioná-lo posteriormente via endpoint Adicionar signatário. | | signer\_phone\_country | String | Código do pais do signatário do documento (Ex: 55). Se houver mais de um signatário no documento, você poderá adicioná-lo posteriormente via endpoint Adicionar signatário. | | signer\_phone\_number | String | Numero do telefone do signatário do signatário do documento (Ex: 11999999999). Se houver mais de um signatário no documento, você poderá adicioná-lo posteriormente via endpoint Adicionar signatário. | | lang | string |idioma do documento. Valores possíveis:
"pt-br" (português)
"es" (espanhol)
"en" (inglês).
Default: "pt-br"
| | disable\_signer\_emails | boolean | para desativar os e-mails enviados aos signatários, envie esse parâmetro como true. Default: false | | brand\_logo | string |se deseja personalizar a logomarca da experiência de assinatura deste documento específico, envie a URL da imagem (precisa ser um link publicamente acessível).
Default: ""
| | brand\_primary\_color | string |se deseja personalizar a cor primária (do botão) da experiência de assinatura deste documento específico, envie em rgb ou hexadecimal.
Ex: "#0011ee".
Default: ""
| | brand\_name | string |se deseja personalizar o nome do remetente dos e-mails enviados ao signatário, insira aqui o nome da marca. Por exemplo, se inserido "XPTO Advogados", o remetente do e-mail será "XPTO Advogados via ZapSign". Max-length: 100 caracteres.
Default: ""
| | external\_id | string |ID do documento na sua aplicação.
Default: ""
| | folder\_path | string |caminho da pasta dentro da ZapSign em que o documento será colocado. Se as pastas não existirem, serão criadas automaticamente. Requisitos: (1) o folder\_path pode ter até 255 caracteres, (2) cada pasta pode ter até 50 caracteres, (3) há um limite de 5 níveis de pasta.
Ex.: "/api/" ou "/pasta1/pasta2/pasta3/".
Default: "/" (sem pasta).
| | created\_by | string |e-mail do usuário que será definido como criador do documento, para fins de organização interna. Caso o e-mail não exista ou não seja usuário da sua conta, este parâmetro será ignorado.
Default: ""
(documento terá como criador aquele usuário que criou o modelo)
| | send\_automatic\_email | boolean |Se true, a ZapSign irá enviar um e-mail ao signatário com o link para assinar o documento. Se false (default), você é quem se encarregará de compartilhar o link de assinatura com o signatário, seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc. Observação: para isso funcionar, é obrigatório que o email do signatário seja definido com um campo dinâmico, por exemplo {{EMAIL DO CLIENTE}}, e esse valor seja enviado junto da requisição.
(se aplica para send\_automatic\_email: true e send\_automatic\_whatsapp: true).
A custom\_message é a mensagem personalizada que você pode inserir no e-mail enviado pela ZapSign ao signatário.
Exemplo: "Olá Fulano, \n Este é o seu contrato de trabalho. \n Abraços, Equipe XPTO". O símbolo \n serve para "pular uma linha" no texto do e-mail.
Default: ""
| | signer\_has\_incomplete\_fields | bolean | Caso definido como *true*, o signatário será direcionado para preencher o formulário do modelo antes de assinar o documento. Observação: valores enviados em *data* já estarão preenchidos, sem que o signatário precise preencher novamente. Default: false. | | reminder\_every\_n\_days | integer |Representa o intervalo de dias entre os lembretes que serão enviados para os signatários, enquanto o signatario não assinar. Serão executadas no máximo 3 tentativas. Observação: este campo só deve ser preenchido se send\_automatic\_whatsapp ou send\_automatic\_email forem true
Exemplo: se definido como 7 será enviada uma tentativa a cada 7 dias, até que o usuario assine, por no máximo 21 dias.
Se true, a ZapSign irá enviar uma mensagem por WhatsApp ao signatário com o link para assinar o documento. Se false (default), você é quem se encarregará de compartilhar o link de assinatura com o signatário, seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc.
Observação: para isso funcionar, é obrigatório que o phone\_country e phone\_number do signatário sejam definidos e cada envio automático via WhatsApp custa R$ 0,50. Adicione créditos em Configurações > Plano.
Se true, a ZapSign irá enviar uma mensagem por WhatsApp ao signatário com o link para o arquivo assinado. Se false (default), você é quem se encarregará de compartilhar o link de assinatura com o signatário, seja pelo seu site, widget, WhatsApp, SMS, e-mail, chat etc.
Observação: para isso funcionar, é obrigatório que o phone\_country e phone\_number do signatário sejam definidos e cada envio automático via WhatsApp custa R$ 0,50. Adicione créditos em Configurações > Plano.
Se preenchido, este campo terá prioridade sobre folder\_path. Ele define o diretório com base no token da pasta, que pode ser obtido acessando o seguinte endereço:[https://app.zapsign.com.br/conta/documentos?pasta=\<token\_da\_pasta>](https://app.zapsign.com.br/conta/documentos?pasta=\<token_da_pasta>)
Se você ainda não souber o token, navegue até a pasta desejada a partir de:
e copie o valor do parâmetro pasta na URL após acessar a pasta.
Permite posicionar a assinatura no documento usando um texto âncora (sem necessidade de coordenadas x, y). Configure signature\_placement: "<<{identificador\_da\_assinatura}>>" e a assinatura será posicionada onde encontrar esse texto. Se o texto aparecer mais de uma vez, a assinatura será posicionada em todos os locais.
Observação: o uso de << >> é altamente recomendado para evitar conflitos com o texto, mas não é obrigatório. Ex: "<>". Default: "". Caso não queira que o texto âncora fique visível no documento final, basta definir a cor do texto âncora igual à cor de fundo do documento.
| | rubrica\_placement | string |Permite posicionar a rubrica no documento usando um texto âncora (sem necessidade de coordenadas x, y). Configure rubrica\_placement: "<<{identificador\_da\_rubrica}>>" e a rubrica será posicionada onde encontrar esse texto. Se o texto aparecer mais de uma vez, a rubrica será posicionada em todos os locais.
Observação: o uso de << >> é altamente recomendado para evitar conflitos com o texto, mas não é obrigatório. Ex: "<>". Default: "". Caso não queira que o texto âncora fique visível no documento final, basta definir a cor do texto âncora igual à cor de fundo do documento.
| {% tabs %} {% tab title="200 Modelo criado com sucesso" %} ``` { "open_id": 5, "token": "eb9c367a-e62f-4992-8360-b0219deaeecc", "status": "pending", "name": "Contrato de Admissão", "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": "João da Silva", "email": "", "phone_country": "", "phone_number": "", "times_viewed": 0, "last_view_at": null, "signed_at": null } ], "answers": [ // lista de variaveis e respostas no modelo dinamico (caso o documento tenha sido criado através de um modelo dinamico) { "variable": "NOME COMPLETO", "value": "Nome Teste" }, { "variable": "NÚMERO DO CPF", "value": "99999999999" }, { "variable": "ENDEREÇO COMPLETO", "value": "Endereço teste" } ] } ``` {% endtab %} {% endtabs %} ### Exemplo de requisição {% embed url="