Comment on page
Editando um documento
Como editar um documento já criado.
Depois de ter criado o documento, você ainda pode editar algumas configurações dele, a mutation para atualização de documento é apresentada a seguir:
mutation (
$id: UUID!,
$document: UpdateDocumentInput!
){
updateDocument(id: $id, document: $document){
id
name
message
reminder
refusable
sortable
stop_on_rejected
new_signature_style
show_audit_page
expiration_at
deadline_at
email_template_id
footer
cc
configs {
notification_finished
notification_signed
signature_appearance
}
created_at
}
}
Campos marcados com um "!" são obrigatórios!
Parâmetros:
id: String (UUID!) que representa o identificador único do documento que você deseja editar.document: Objeto(UpdateDocumentInput!) que contém os detalhes das propriedades que serão editadas no documento.
Após, ainda precisamos atribuir os valores das variáveis declaradas na mutation, em um JSON. Exemplo de valores para as variáveis da mutation:
{
"id": "ID_DO_DOCUMENTO",
"document": {
"name": "NOME_DOCUMENTO",
"message": "Mensagem customizada enviada para os emails dos signatários",
"reminder": "WEEKLY",
"sortable": true,
"footer": "BOTTOM",
"refusable": true,
"new_signature_style": true,
"show_audit_page": false,
"ignore_cpf": true,
"email_template_id": 1234,
"deadline_at": "2023-11-24T02:59:59.999Z",
"cc": [
{ "email": "[email protected]" },
{ "email": "[email protected]" }
],
"expiration": {
"days_before": 7,
"notify_at": "20/01/2026"
}
}
}
A tabela a seguir descreve os campos que podem ser incluídos no objeto
UpdateDocumentInput.Campo | Tipo | Descrição |
|---|---|---|
name | String | O novo nome para o seu documento |
message | String | Uma mensagem personalizada que será enviada para os emails dos signatários. |
reminder | 'DAILY' | 'WEEKLY' | Define a frequência dos lembretes por email. |
refusable | Boolean | Se true, permite que os signatários recusem assinar o documento. |
ignore_cpf | Boolean | Remove obrigatoriedade de preencher CPF para assinar |
stop_on_rejected | Boolean | Impede que outras pessoas assinem quando recusado |
sortable | Boolean | Signatários assinam na ordem do array "signers" |
new_signature_style | Boolean | Se true, ativa o uso de um estio de assinatura atualizado. |
show_audit_page | Boolean | Evita criar a última página de auditoria. Requer "new_signature_style": true |
expiration | Envia um lembrete de vencimento para os signatários. | |
footer | 'BOTTOM' | 'LEFT' | 'RIGHT' | Define a posição do rodapé no documento. |
cc | [ String! ] | Envia emails quando o documento for assinado por todos os signatários |
configs | Outras configurações do documento. | |
deadline_at | String | Data no formato ISO 8601, como "YYYY-MM-DDTHH:MM:SS.SSSZ"). A data limite para a assinatura do documento. |
Objeto dentro de
UpdateDocumentInput que contém informações sobre a expiração do documento.Campo | Tipo | Descrição |
|---|---|---|
days_before | Int! | Quantidade de dias antes do vencimento para enviar a notificação. |
notify_at | Date! | Data de vencimento do documento. |
Sub-objeto dentro de
UpdateDocumentInput para configurações adicionais.Campo | Tipo | Descrição |
|---|---|---|
notification_finished | Boolean | Ativa a notificação de conclusão do documento |
notification_signed | Boolean | Enviar email ao signatário quando ele assinar |
signature_appearance | 'DRAW' | 'HANDWRITING' | 'ELETRONIC' | 'IMAGE' | Força a aparência das assinaturas para a opção selecionada. |
Você pode conferir o que é cada um desses parâmetros direto na documentação completa da API GraphQL, no menu Docs do Altair. Se você não sabe como fazer isso, confira o nosso tutorial em Usando o Altair.
Se o Altair não te ajuda para integrar com a API, confira alguns exemplos de como fazer essas requisições de outra forma: https://graphql.org/graphql-js/graphql-clients/
Last modified 1mo ago