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

Transferindo um Documento

Como transferir um documento para uma organização.

Para transferir um documento, você pode utilizar a seguinte mutation.

mutation {
  transferDocument(
    id: "ID_DO_DOCUMENTO",
    organization_id: "ID_DA_ORGANIZACAO",
    group_id: "ID_DO_GRUPO"
  )
}

Parâmetros

  • id: String (UUID!), que representa o identificador único do documento.

  • organization_id: Int! , que representa o identificador da organização que receberá o documento.

  • group_id: Int!, que representa o identificador do grupo que receberá o documento.

Também é possível atribuir os seguintes parâmetros opcionais:

  • current_group_id: Int, que representa o identificador do grupo atual do documento, caso este pertença a um.

  • context: ContextEnum (USER, GROUP ou ORGANIZATION), que representa o contexto em que o documento está.

Resposta esperada:

{
  "data": {
    "transferDocument": true
  }
}
AnteriorRemovendo um DocumentoPróximoAdicionar Signatário

Atualizado há 6 meses

Isto foi útil?

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/