Skip to main content

Update User Preferences

PUT 
/v1/users/{userId}/preferences

Updates preference settings for a user account.

Common Use Cases​

  • Enable scam blocking: Set scamBlockEnabled: true
  • Customize greeting: Provide customScreenerGreeting (max 150 characters)
  • Adjust security level: Set screenerSecurityLevel to ExtraSecure, Secure, or Safe

Path Parameters​

    userId stringrequired

    UUID for the given user

Header Parameters​

    x-hiya-product-version string

    Product version. The standard "major.minor.patch" format is highly encouraged without any leading characters; "2.1.3" or "3.0.0" for example.

    x-hiya-account-user-id stringrequired

    The identifier of a logged-in user. Same identifier that is used for /users/{user_id}

Body

required

application/json

Responses​

Successfully added