updateUser

Updates the specified User object.

Access is permitted when any of the following condition(s) are met: 1. The specified object is the signed-in User. 2. The signed-in User has any of the following permissions for the associated Organization: [org_admin_users] when a value for 'customer' does not exist on the object. 3. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_users] when a value for 'customer' exists on the object. 4. The signed-in User has any of the following permissions for the associated Organization: [org_admin_customer_permissions, org_manage_customers] when a value for 'customer' exists on the object.

Input fields (UpdateUserInput!)

ArgumentTypeDescription
nameStringThe user's preferred name.
darkModeBooleanDesignates whether the User has dark mode activated or not.
darkModeSyncWithOsBooleanDesignates whether dark mode should be derived from the operating system.
roleIDThe role to associate with the User.
phoneStringThe preferred contact phone number for the User.
avatarUrlStringThe URL for the avatar image.
idIDThe ID of the User to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (UpdateUserPayload)

user (User)
errors ([ErrorType])
clientMutationId (String)
Last updated on