---
id: user-write
title: "Update a user"
description: "Updates a user in your organization."
sidebar_label: "Update a user"
hide_title: true
hide_table_of_contents: true
api: eJzdWNtuGzcQ/RVinhJjLTuJ3YcFWsS5FHUf0sCxkQC2YY+WI4nJLrkhubIVYd/63t9pf6c/0F8ohqSs1cW3Ok2Bvggrcsi5cM7MIacgyRVW1V4ZDTkc1RI9OYGicWSF0mJiGiuMHaJWX5Cleif6ROd5rvTAiF90OQmiTpiB8JOaxHlN1hl9LgrUok+iCVvKXlh0oiEDU5MNW+1LyIFX5xdWeYIMPA4d5Mdw5MjCaQaOisYqP4H8eAp9Qkt2r/EjyI9P29MMarRYkSfrgoBiF2r0I8hAY0WQg5KQgStGVCHkU2ALeVR7GpKFNgNLnxtlSULubUPZUjwORyT2XwXfRhRjMjGNuEDthTfJtxCRH8Sfv/7x1++/iY2NN8ZTvrFxv+AA+8PGkPMvjJywtcu2FUZ70p6nsK5LVYQobn10bOt01U3T/0iFhwxqyzH3ilyQ8+ib8LXqbJy7i8Oi4/G+Hhj2+B35sC7t4o04x8KrMZ3zN5aluZjv640ozZBzzJswWpfoB8ZWmTBh9lzpzura0pi05zVKCywKcq4X8ol0U3HSRGHIYLaOMyiFwnmr9JCFL7GqSx5KMm0GVKEq18cjTN0WDrhRTUmXPWnoediqV5iKVQ6Udf4sJuk6vWFe8PyDlO+VdMnqSrxRG08/XNkrE6LZLRZnSq7X2BW6A8LmemfQ7Sh+8vTZTpsBjtGjXa8uzj3Iu5H3tcu3tqrJZtxts7HpONsMvPJBird+H4pZ27ahvLjaaBeB93R755pozCqiuEAnXBOSe9CUbNE/Bv28ehzHMqhtQEtI9oUM7ObH6vmdLtePeKYr53Fb5ewtn9nud/fE3h2AVg3t88JOam82lS4ehrZ16nRTlthnfbEkfx2o3Y6rZc1fAWd3AtX9ekXvxmqcQU1aRu+UHitP8q4V+n7Yvt/B3QDs2Tbr1IZ+fo3vsctDBhUWI6VvaURJug04GytJ1zna+BFpnyqAmAnfmkjJqMIMtfKG+RBWJZt0fUxmsm2sGmvNeXPw5u453M3D7588fcY7O9LyLCbCqob3I/KjyBJYTqAWUTSVhcQZljT3jSkJdahGA2xKv+JaAk9FHiV6XO/abPYa/65K7NWuU/hEE8hhjGUTSv9iRzhIXSA1hZ0PH1b1viwV0xuy1lhx1TaEbIh9VXqMpZJC6brxzI8q5ZzSQzGnwF+tWURcvzSSIRvs4Uwm53BIq92gI317V/jp8PDtrG4URpKwVFtynNV6GKljTYUaqEIU3Xg8ot6wl4md7W3+ecI/z/hn5/FCV9nZ3m45CAu2XGXjoil7IoFz0xJKhkHSFezyI/SiQE9DY9UXctE2smOyYoCqbCwtaIY+yrNE3wOlDGG7gxF9q2iQiVFToZ5b0pGa5WA0LlSdFI0TeIFSHESlJ8ADR5qLRDBZnsBicLrS0M5P9HYjpVT8iaWQ5FGVTmDfNH5u1qIeRlAKReAzFZZM60mKEF3tUWmSVyndzeC2jQjZXYeQdzH8ywhRWoY818NQJJxrSBgdjNt7uy+ckvQ/g4brBiIlwy5DY3f7Kf88Wzz43f8OFeys1VieRaGzGLJvho/9pF6k1HnNMhEpPKIKEkcax6hCG1wBzNrl/yp09rRoNF3WVHiSySVTFI21JHvibUnoSHg7EThEpUWJnhtTO4NNRX5k+FGlbsK1n59CctjiFrQ1VbLl3h9cie8ljS07/Adr1WNGMLuGRwrUeYR5xxCJmd19irmKAW80e20JJTEIQZY+fjS2Qg85/Pz+MNyZGHoH8xeP1/NmOmOdcxKZrgnrbtOL9D7y8AUangj0Cl9mijunljfzQH7tYss4dvFon/S2e9sw7/NvOqHjwhP4nHG+wlBfkinxgS29ry2ny3RepL7NS1w6OE+XfqsuUQUSGrJimpLnGJKhebwJjozzPDqd9tHRkS3bloc/N2T5ke40gzFaFUnl8RSkcvwtIR9g6Zaf17r+PjpIZfax+IaPbteEIA2inkCWOF0OkCWSpyS0p20GI8LA1Y9n7O9l9GbzkJfPF660mzabrdgrCqr9jbKnHVi/PTpkOKXnwSpUdLB4wV0KL6KNJgQ3oDSMTaFEPWxCuYK4JYMPF7G7hNXg1NooTKdR4tB8It22V0Hx/J/j0rZ/A1DVuNA=
sidebar_class_name: "put api-method"
info_path: docs/api/nullplatform-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update a user"}
>
</Heading>

<MethodEndpoint
  method={"put"}
  path={"/user/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Updates a user in your organization.

:::info Only users of type `person` can be updated.
:::


<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"path","name":"id","schema":{"type":"integer"},"required":true,"description":"The ID of the user you want to update.\n\n> ℹ️ **Note:** Only users of type `person` can be updated.\n"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"description":"The status of the user you want to update.\n\n > ℹ️ **Info:** Set the status to `active` to allow the user to log in to the platform, or to `inactive` to prevent login access.\n","enum":["active","inactive"],"type":"string","example":"active"},"email":{"description":"The email of the user you want to update.","type":"string","example":"alex.doe@email.com"},"first_name":{"description":"The first name of the user you want to update.","type":"string","example":"Alex"},"last_name":{"description":"The last name of the user you want to update.","type":"string","example":"Doe"},"organization_id":{"description":"The organization ID of the user you want to update.","type":"integer","example":1234},"avatar":{"description":"The avatar of the user you want to update.","type":"string","example":"https://my-avatar-url.com"}},"title":"userWrite"}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"204":{"description":"The operation was successful.","content":{"application/json":{"schema":{"type":"object","required":["id","nrn","email","first_name","last_name","organization_id"],"properties":{"id":{"type":"integer","description":"The ID of the user.","example":123456},"email":{"description":"The email of the user.","type":"string","example":"alex.mgr@crypto-inc.com"},"first_name":{"description":"The first name of the user.","type":"string","nullable":true,"example":"Alex"},"last_name":{"description":"The last name of the user.","type":"string","example":"Doe","nullable":true},"organization_id":{"description":"The organization ID of the user.","type":"integer","example":1234},"status":{"description":"The status of the user.","enum":["active","inactive","pending","invited"],"type":"string","example":"active"},"avatar":{"description":"The avatar of the user.","type":"string","nullable":true,"example":"https://my-avatar-url.com"},"type":{"description":"The type of the user.","enum":["person","machine"],"type":"string","example":"person"},"provider":{"description":"The authentication provider of the user.","type":"string","enum":["cognito","saml"],"nullable":true,"example":"cognito"},"nrn":{"description":"The NRN of the user.","type":"string","example":"organization=123"},"send_invite":{"description":"Whether to send an invite email to the user.","type":"boolean","default":true,"example":true},"metadata":{"description":"The metadata of the user.","type":"object","example":{"key":"value"}}},"title":"userResponse"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>