Skip to main content

staffUpdate Mutation

Updates an existing staff user. Apps are not allowed to perform this mutation.

Requires the MANAGE_STAFFpermission.

Triggers the following webhook events:

  • STAFF_UPDATED (async): A staff account was updated.
staffUpdate(
  id: ID!
  input: StaffUpdateInput!
): StaffUpdate
Details
type StaffUpdate {
  staffErrors: [StaffError!]! @deprecated
  errors: [StaffError!]!
  user: User
}

Arguments​

id ● ID!​

ID of a staff user to update.

input ● StaffUpdateInput!​

Fields required to update a staff user.

Type​

StaffUpdate​

Updates an existing staff user. Apps are not allowed to perform this mutation.

Requires the MANAGE_STAFFpermission.

Triggers the following webhook events:

  • STAFF_UPDATED (async): A staff account was updated.