gainsight-px-rest-api

Get user preferences (identifyId passed via request body)

POST /v1/user/preferences

If the field is not set - return null.

application/json

Body Required

User identify id

  • identifyId string Required

Responses

  • 200 */*

    Success

    Hide response attributes Show response attributes object
    • guidedTours boolean
    • onboardingBot boolean
    • productUpdates boolean
    • surveys boolean
    • trackUsage boolean
  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 403

    Access denied

  • 404

    User not found by id

  • 429

    Rate limit exceeded

POST /v1/user/preferences 
curl \
 --request POST 'https://api.aptrinsic.com/v1/user/preferences' \
 --header "Content-Type: application/json" \
 --data '{"identifyId":"string"}'
Request examples 
{
  "identifyId": "string"
}
Response examples (200) 
{
  "guidedTours": true,
  "onboardingBot": true,
  "productUpdates": true,
  "surveys": true,
  "trackUsage": true
}