gainsight-px-rest-api

Update user preferences, this version of API can take 'trackEmailAnalytics' and 'identifyId' property in the payload.

PUT /v2/user/preferences

The fields are optional so it’s possible to provide only those that need to be updated.

If the user had preferences - override only the provided fields.

Valid field values: true, false, null.

Note: null value won’t override any other.

application/json

Body Required

User preferences

  • guidedTours boolean
  • onboardingBot boolean
  • productUpdates boolean
  • surveys boolean
  • trackEmailAnalytics boolean
  • trackUsage boolean

Responses

  • 204

    Updated

  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 403

    Access denied

  • 404

    User not found by id

  • 429

    Rate limit exceeded

PUT /v2/user/preferences 
curl \
 --request PUT 'https://api.aptrinsic.com/v2/user/preferences' \
 --header "Content-Type: application/json" \
 --data '{"guidedTours":true,"onboardingBot":true,"productUpdates":true,"surveys":true,"trackEmailAnalytics":true,"trackUsage":true}'
Request examples 
{
  "guidedTours": true,
  "onboardingBot": true,
  "productUpdates": true,
  "surveys": true,
  "trackEmailAnalytics": true,
  "trackUsage": true
}