---
title: "Update member"
method: PATCH
path: "/v2/members/{memberId}"
tags: ["Members"]
---

# Update member

`PATCH /v2/members/{memberId}`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/members/{memberId}`
- Auth: HTTP bearer

Update a specific user by memberId.

  ### Usage notes
  - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint.
  - Review the account types returned by the same endpoint to understand the format of the **memberType** string.
  - To deactivate a user and reassign their documents to a specific user, set  `newOwnerId`to the user ID of the desired document owner, and `isArchived` to `True`. For more details, see [Deactivate a user](/docs/deactivate-users).

## Path parameters

- `memberId` string, required

## Request body

- object
  - `memberType` string: Account type
  - `firstName` string
  - `lastName` string
  - `profileImgUrl` string, nullable
  - `email` string
  - `language` 'DE_DE' | 'EN' | 'EN_AU' | 'EN_CA' | 'EN_GB' | 'EN_IE' | 'ES_ES' | 'ES_MX' | 'FR_CA' | 'FR_FR' | 'IT_IT' | 'JA_JA' | 'KO_KR' | 'NL_NL' | 'PL_PL' | 'PT_BR' | 'PT_PT' | 'RU_RU' | 'SV_SE' | 'TH_TH' | 'TR_TR' | 'ZH_CN' | 'ZH_TW': The user's preferred display language. Pass `null` to revert to the organization default. (Beta)
  - `formatRegion` 'AU' | 'BR' | 'CA' | 'CN' | 'DE' | 'ES' | 'FR' | 'GB' | 'IE' | 'IT' | 'JP' | 'KR' | 'MX' | 'NL' | 'PL' | 'PT' | 'RU' | 'SE' | 'TH' | 'TR' | 'TW' | 'US': Controls number, date, and currency formatting for the user, following the conventions of the specified region. Pass `null` to revert to the organization default. (Beta)
  - `isArchived` boolean: Whether to deactivate a user in Sigma.
  - `isInactive` boolean: Whether to archive a user with SCIM.
  - `userKind` 'internal' | 'guest' | 'embed'
  - `newOwnerId` string
  - `archiveDocuments` boolean: Archive a user's documents instead of transferring them. Can only be used if either `isArchived` or `isInactive` is set to `true`. Also archives scheduled exports.
  - `archiveScheduledExports` boolean: Archive a user's scheduled exports instead of transferring them. Can only be used if either `isArchived` or `isInactive` is set to `true`

## Response `200`

The response body.

- MembersUpdateMemberResponse200
  - `organizationId` string, required
  - `memberId` string, required
  - `memberType` string, required
  - `firstName` string, required
  - `lastName` string, required
  - `email` string, required
  - `profileImgUrl` string, nullable, required
  - `createdBy` string, required
  - `updatedBy` string, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `homeFolderId` string, required: ID of the My Documents folder for the user
  - `userKind` string, required
  - `language` 'DE_DE' | 'EN' | 'EN_AU' | 'EN_CA' | 'EN_GB' | 'EN_IE' | 'ES_ES' | 'ES_MX' | 'FR_CA' | 'FR_FR' | 'IT_IT' | 'JA_JA' | 'KO_KR' | 'NL_NL' | 'PL_PL' | 'PT_BR' | 'PT_PT' | 'RU_RU' | 'SV_SE' | 'TH_TH' | 'TR_TR' | 'ZH_CN' | 'ZH_TW': The user's preferred display language. (Beta)
  - `formatRegion` 'AU' | 'BR' | 'CA' | 'CN' | 'DE' | 'ES' | 'FR' | 'GB' | 'IE' | 'IT' | 'JP' | 'KR' | 'MX' | 'NL' | 'PL' | 'PT' | 'RU' | 'SE' | 'TH' | 'TR' | 'TW' | 'US': Controls number, date, and currency formatting for the user, following the conventions of the specified region. (Beta)
  - `isArchived` boolean: Whether a user is deactivated in Sigma.
  - `isInactive` boolean: Whether a user is archived by SCIM.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)