update_user
Modify user details in Zendesk by updating name, email, role, phone, organization, tags, or notes for specified user IDs.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | User ID to update | |
| name | No | Updated user's name | |
| No | Updated email address | ||
| role | No | Updated user's role | |
| phone | No | Updated phone number | |
| organization_id | No | Updated organization ID | |
| tags | No | Updated tags for the user | |
| notes | No | Updated notes about the user |
Implementation Reference
- src/tools/users.js:106-131 (handler)The MCP tool handler for 'update_user'. Builds userData object from provided optional fields and calls the Zendesk client's updateUser method. Returns formatted success or error response.handler: async ({ id, name, email, role, phone, organization_id, tags, notes }) => { try { const userData = {}; if (name !== undefined) userData.name = name; if (email !== undefined) userData.email = email; if (role !== undefined) userData.role = role; if (phone !== undefined) userData.phone = phone; if (organization_id !== undefined) userData.organization_id = organization_id; if (tags !== undefined) userData.tags = tags; if (notes !== undefined) userData.notes = notes; const result = await zendeskClient.updateUser(id, userData); return { content: [{ type: "text", text: `User updated successfully!\n\n${JSON.stringify(result, null, 2)}` }] }; } catch (error) { return { content: [{ type: "text", text: `Error updating user: ${error.message}` }], isError: true }; } }
- src/tools/users.js:96-105 (schema)Zod input schema for the 'update_user' tool, defining required 'id' and optional update fields.schema: { id: z.number().describe("User ID to update"), name: z.string().optional().describe("Updated user's name"), email: z.string().email().optional().describe("Updated email address"), role: z.enum(["end-user", "agent", "admin"]).optional().describe("Updated user's role"), phone: z.string().optional().describe("Updated phone number"), organization_id: z.number().optional().describe("Updated organization ID"), tags: z.array(z.string()).optional().describe("Updated tags for the user"), notes: z.string().optional().describe("Updated notes about the user") },
- src/server.js:48-52 (registration)Registration loop that registers all tools, including 'update_user' from usersTools, with the MCP server using server.tool().allTools.forEach((tool) => { server.tool(tool.name, tool.schema, tool.handler, { description: tool.description, }); });
- src/zendesk-client.js:113-115 (helper)ZendeskClient helper method that performs the actual PUT request to /users/{id}.json API endpoint to update the user.async updateUser(id, data) { return this.request("PUT", `/users/${id}.json`, { user: data }); }