Transfering a document

How to transfer a documento to an organization

To transfer a document, you may use the following mutation:

mutation {
  transferDocument(
    id: "DOCUMENT_ID",
    organization_id: "ORGANIZATION_ID",
    group_id: "GROUP_ID"
  )
}

Parameters

  • id: A String (UUID!) representing the unique identifier of the document.

  • organization_id: An Int! representing the ID of the organization that will receive the document.

  • group_id: An Int! representing the ID of the group that will receive the document.

You can also include the following optional parameters:

  • current_group_id: An Int representing the current group ID of the document, if it belongs to one.

  • context: A ContextEnum (USER, GROUP, or ORGANIZATION) that defines the context in which the document is located.

Expected response:

{
  "data": {
    "transferDocument": true
  }
}
circle-info

You can check what each of these parameters means directly in the full GraphQL API documentation, in the Docs menu of Altairarrow-up-right. If you're not sure how to do that, check out our tutorial on Using Altair.

circle-info

If Altair doesn't help you integrate with the API, check out some examples of how to make these requests in other ways: https://graphql.org/graphql-js/graphql-clients/arrow-up-right

Last updated