GAgainsight
Users

Update user (identifyId passed via request body)

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.

put/v1/users/update

Request

Request body

aptrinsicIdstring
identifyIdstring required
type'LEAD' | 'USER' | 'VISITOR' | 'EMPTY_USER_TYPE'
gender'MALE' | 'FEMALE' | 'OTHER' | 'EMPTY_GENDER'
emailstring
firstNamestring
lastNamestring
lastSeenDateinteger
signUpDateinteger
firstVisitDateinteger
titlestring
phonestring
scoreinteger
rolestring
subscriptionIdstring
accountIdstring
numberOfVisitsinteger
propertyKeysstring[] required

Aptrinsic Tag Key, at least one is required

createDateinteger
lastModifiedDateinteger
customAttributesobject

Map of apiName to value

globalUnsubscribeboolean
sfdcContactIdstring
idstring

Synonym for identifyId, output only, not filterable

globalIdstring

Global user ID, only applicable for workspace-enabled subscriptions

Example request

{
  "location": {
    "countryName": "United States",
    "countryCode": "USA",
    "stateName": "California",
    "stateCode": "CA",
    "city": "San Mateo",
    "street": "101 Broadway",
    "continent": "NA",
    "coordinates": {
      "latitude": 37.567147,
      "longitude": -122.324211
    }
  },
  "propertyKeys": [
    "AP-XXXXXXXXXX-2"
  ],
  "lastInferredLocation": {
    "countryName": "United States",
    "countryCode": "USA",
    "stateName": "California",
    "stateCode": "CA",
    "city": "San Mateo",
    "street": "101 Broadway",
    "continent": "NA",
    "coordinates": {
      "latitude": 37.567147,
      "longitude": -122.324211
    }
  }
}

Response

Updated

bodyobject
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'
statusCodeValueinteger

Changes

No recorded changes to this operation across all 1 revision of this API.