Update user preferences (identifyId passed via request body)

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://px-apidocs.gainsight.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "gainsight-px-rest-api MCP server": {
    "url": "https://px-apidocs.gainsight.com/mcp"
  }
}

Close
PUT /v1/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
  • 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 /v1/user/preferences
curl \
 --request PUT 'https://api.aptrinsic.com/v1/user/preferences' \
 --header "Content-Type: application/json" \
 --data '{"guidedTours":true,"onboardingBot":true,"productUpdates":true,"surveys":true,"trackUsage":true}'
Request examples
{
  "guidedTours": true,
  "onboardingBot": true,
  "productUpdates": true,
  "surveys": true,
  "trackUsage": true
}