Skip to main content

StaffUpdateInput

No description

input StaffUpdateInput {
firstName: String
lastName: String
email: String
isActive: Boolean
note: String
companyName: String
personalPhone: String
passwordUrl: String
taxExemptCode: String
customFields: [AttributeValueInput!]
addGroups: [ID!]
sellerId: ID
removeGroups: [ID!]
isStaff: Boolean @deprecated
}

Fields

StaffUpdateInput.firstName ● String scalar

Given name.

StaffUpdateInput.lastName ● String scalar

Family name.

StaffUpdateInput.email ● String scalar

The unique email address of the user.

StaffUpdateInput.isActive ● Boolean scalar

User account is active.

StaffUpdateInput.note ● String scalar

A note about the user.

StaffUpdateInput.companyName ● String scalar

Only filled out if the account is a business account.

StaffUpdateInput.personalPhone ● String scalar

Personal phone number.

StaffUpdateInput.passwordUrl ● String scalar

Password url

StaffUpdateInput.taxExemptCode ● String scalar

Tax exempt code

StaffUpdateInput.customFields ● [AttributeValueInput!] list input

List of custom fields.

StaffUpdateInput.addGroups ● [ID!] list scalar

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

StaffUpdateInput.sellerId ● ID scalar

ID of the seller to which the staff member belongs.

StaffUpdateInput.removeGroups ● [ID!] list scalar

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

StaffUpdateInput.isStaff ● Boolean deprecated scalar

DEPRECATED

Staff update always produces a staff user, will be removed on January 15, 2026

User is staff member.

Member Of

staffUpdate mutation

Was this page helpful?