---
title: "Update user (identifyId passed via request body)"
method: PUT
path: "/v1/users/update"
tags: ["Users"]
---

# Update user (identifyId passed via request body)

`PUT /v1/users/update`

## Request

- Base URL: `https://app.aptrinsic.com`
- URL: `https://app.aptrinsic.com/v1/users/update`
- Auth: none declared
- TypeScript: <https://skmtc.dev/gainsight/apis/gainsight-px-rest-api/docs/v1/users/update/put.ts> (a function with typed inputs; its response is checked against the schema)

Updates a user with identifyId specified in the request body.
This update method is useful when the identify ID contains special characters that make it impossible to use the update method with the identifyId in the request path.

## Request body

- User: User object
  - `aptrinsicId` string
  - `identifyId` string, required
  - `type` 'LEAD' | 'USER' | 'VISITOR' | 'EMPTY_USER_TYPE'
  - `gender` 'MALE' | 'FEMALE' | 'OTHER' | 'EMPTY_GENDER'
  - `email` string
  - `firstName` string
  - `lastName` string
  - `lastSeenDate` integer
  - `signUpDate` integer
  - `firstVisitDate` integer
  - `title` string
  - `phone` string
  - `score` integer
  - `role` string
  - `subscriptionId` string
  - `accountId` string
  - `numberOfVisits` integer
  - `location` Location: Location object
    - `countryName` string
    - `countryCode` string: See ISO 3166
    - `stateName` string
    - `stateCode` string: See ISO 3166
    - `city` string
    - `street` string
    - `postalCode` string
    - `continent` string: See ISO 3166
    - `regionName` string: See ISO 3166-2
    - `timeZone` string
    - `coordinates` Coordinates: Coordinates object
      - `latitude` number, double
      - `longitude` number, double
  - `propertyKeys` string[], required: Aptrinsic Tag Key, at least one is required
  - `createDate` integer
  - `lastModifiedDate` integer
  - `customAttributes` object: Map of apiName to value
  - `globalUnsubscribe` boolean
  - `sfdcContactId` string
  - `channelMetricList` ChannelMetric[]
    - `groupId` string
    - `channel` integer
    - `environment` integer
    - `firstSeenDate` integer
    - `lastSeenDate` integer
  - `lastVisitedUserAgentData` UserAgentByProduct[]
    - `propertyKey` string
    - `userAgent` UserAgent: User Agent object
      - `rawUserAgent` string
      - `device` string
      - `platformType` string
      - `platformVersion` string
      - `browserType` string
      - `browserVersion` string
  - `id` string: Synonym for identifyId, output only, not filterable
  - `lastInferredLocation` Location: Location object
    - `countryName` string
    - `countryCode` string: See ISO 3166
    - `stateName` string
    - `stateCode` string: See ISO 3166
    - `city` string
    - `street` string
    - `postalCode` string
    - `continent` string: See ISO 3166
    - `regionName` string: See ISO 3166-2
    - `timeZone` string
    - `coordinates` Coordinates: Coordinates object
      - `latitude` number, double
      - `longitude` number, double
  - `globalId` string: Global user ID, only applicable for workspace-enabled subscriptions

## Response `204`

Updated

- ResponseEntity
  - `body` object
  - `statusCode` '100' | '101' | '102' | '103' | '200' | '201' | '202' | '203' | '204' | '205' | '206' | '207' | '208' | '226' | '300' | '301' | '302' | '303' | '304' | '305' | '307' | '308' | '400' | '401' | '402' | '403' | '404' | '405' | '406' | '407' | '408' | '409' | '410' | '411' | '412' | '413' | '414' | '415' | '416' | '417' | '418' | '419' | '420' | '421' | '422' | '423' | '424' | '426' | '428' | '429' | '431' | '451' | '500' | '501' | '502' | '503' | '504' | '505' | '506' | '507' | '508' | '509' | '510' | '511'
  - `statusCodeValue` integer

## Other responses

- `401`: Unauthorized or bad API Key
- `404`: User not found
- `429`: Rate limit exceeded

---

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