Skip to main content

CreateAccessTierInput

Input for creating a new app access tier.

input CreateAccessTierInput {
  appId: BigInt!
  name: String!
  tierOrder: Int
  isFree: Boolean
  isDefault: Boolean
  description: String
  permissionKeys: [String!]
  applyCommunicationDefaults: Boolean
}

Fields​

CreateAccessTierInput.appId ● BigInt! non-null scalar​

Numeric id of the app the tier belongs to. The caller must hold manage_access_tiers on this app.

CreateAccessTierInput.name ● String! non-null scalar​

Tier display name (max 128 chars).

CreateAccessTierInput.tierOrder ● Int scalar​

Optional sort order (ascending). Defaults to 0.

CreateAccessTierInput.isFree ● Boolean scalar​

Optional; whether the tier is free. Defaults to false.

CreateAccessTierInput.isDefault ● Boolean scalar​

Optional; whether this is the app's default tier. Defaults to false.

CreateAccessTierInput.description ● String scalar​

Optional marketing description of the tier.

CreateAccessTierInput.permissionKeys ● [String!] list scalar​

Optional runtime permission keys to grant on this tier (must be valid runtimePermissions). Defaults to ["access"] when omitted.

CreateAccessTierInput.applyCommunicationDefaults ● Boolean scalar​

When true (the default) and the tier grants access, it also grants use_text_chat and use_direct_messages, whether or not permissionKeys names them: without them the realtime servers refuse the tier’s text chat and direct messages. Pass false to grant exactly permissionKeys, for example a tier without text chat.

Member Of​

createAccessTier mutation