Documentação
HomePainelChaves de API
API v2
API v2
  • Introdução
  • Sobre o GraphQL
  • Preços para uso via API
  • Integrando com a API
    • Usando o Altair
    • Sandbox/testes
    • Webhooks
    • Webhooks (deprecado)
    • Mensagens de erro
  • Queries
    • Buscar Usuário Atual
    • Resgatando Documentos
    • Listar Organizações
    • Listando Pastas
    • Listando Modelos de Email
  • Mutations
    • Criando um Documento
      • Assinando um Documento
    • Editando um Documento
    • Removendo um Documento
    • Transferindo um Documento
    • Adicionar Signatário
    • Remover Signatário
    • Criando Pastas
    • Removendo Pastas
    • Movendo Documento para Pasta
    • Reenviar Assinaturas
    • Criar Link de Assinatura
    • Aprovar Verificação Biométrica Pendente
    • Rejeitar Verificação Biométrica Pendente
Fornecido por GitBook
Nesta página

Isto foi útil?

  1. Mutations

Remover Signatário

Como remover um signatário de um documento já criado.

AnteriorAdicionar SignatárioPróximoCriando Pastas

Atualizado há 6 meses

Isto foi útil?

Para remover um signatário de um documento, você pode executar a seguinte mutation.

Definição da Mutation:

Aqui está a definição da mutation que você deve usar para remover um signatário:

mutation {
  deleteSigner(public_id: "PUBLIC_ID_DO_SIGNATARIO", document_id: "ID_DO_DOCUMENTO")
}

Parâmetros

  • public_id: String (UUID!). Identificador do signatário, adquirido ao obter os signatários de um documento.

  • document_id: String (UUID!). Identificador do documento no qual você deseja excluir o signatário.

Resposta esperada:

{
  "data": {
    "deleteSigner": true
  }
}

Você pode conferir o que é cada um desses parâmetros direto na documentação completa da API GraphQL, no menu Docs do . Se você não sabe como fazer isso, confira o nosso tutorial em .

Se o Altair não te ajuda para integrar com a API, confira alguns exemplos de como fazer essas requisições de outra forma:

Altair
Usando o Altair
https://graphql.org/graphql-js/graphql-clients/