updateUsersWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the updateUsersWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow updates one or more users. It's used by the Update User Admin API Route.
You can use this workflow within your customizations or your own custom workflows, allowing you to update users within your custom flows.
Source CodeExamples#
Steps#
Input#
UpdateUsersWorkflowInputDTOUpdateUsersWorkflowInputDTO
UpdateUsersWorkflowInputDTOUpdateUsersWorkflowInputDTOupdatesUpdateUserDTO[]The users to update.
updatesUpdateUserDTO[]Output#
UserDTO[]UserDTO[]
UserDTO[]UserDTO[]idstringThe ID of the user.
idstringemailstringThe email of the user.
emailstringfirst_namenull | stringThe first name of the user.
first_namenull | stringlast_namenull | stringThe last name of the user.
last_namenull | stringavatar_urlnull | stringThe avatar URL of the user.
avatar_urlnull | stringmetadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>created_atDateThe creation date of the user.
created_atDateupdated_atDateThe updated date of the user.
updated_atDatedeleted_atnull | DateThe deletion date of the user.
deleted_atnull | DateWas this page helpful?