Skip to main content

AppRequiredDocumentInput

One document an app requires its players to accept.

input AppRequiredDocumentInput {
  documentId: String!
  version: String!
  title: String!
  url: String!
}

Fields​

AppRequiredDocumentInput.documentId ● String! non-null scalar​

1-64 lower-case letters, digits and hyphens, unique in the app and not one of the platform's own ids (player-terms, game-terms, ...).

AppRequiredDocumentInput.version ● String! non-null scalar​

The version players must accept, 1-128 of letters, digits and . _ : + - (a date is usual: rules-2026-11-01). Changing it asks every player of the app again.

AppRequiredDocumentInput.title ● String! non-null scalar​

Title shown to players, 1-200 characters.

AppRequiredDocumentInput.url ● String! non-null scalar​

https URL where players read the document.

Member Of​

setAppRequiredDocuments mutation