Skip to main content

StaffUpdateInput Input Type

Fields required to update a staff user.

input StaffUpdateInput {
  firstName: String
  lastName: String
  email: String
  isActive: Boolean
  note: String
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
  addGroups: [ID!]
  removeGroups: [ID!]
}

Fields​

StaffUpdateInput.firstName ● String scalar miscellaneous​

Given name.

StaffUpdateInput.lastName ● String scalar miscellaneous​

Family name.

StaffUpdateInput.email ● String scalar miscellaneous​

The unique email address of the user.

StaffUpdateInput.isActive ● Boolean scalar miscellaneous​

User account is active.

StaffUpdateInput.note ● String scalar miscellaneous​

A note about the user.

StaffUpdateInput.metadata ● [MetadataInput!] list input miscellaneous​

Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

StaffUpdateInput.privateMetadata ● [MetadataInput!] list input miscellaneous​

Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

StaffUpdateInput.addGroups ● [ID!] list scalar miscellaneous​

List of permission group IDs to which user should be assigned.

StaffUpdateInput.removeGroups ● [ID!] list scalar miscellaneous​

List of permission group IDs from which user should be unassigned.

Member Of​

staffUpdate mutation