---
title: "Update user details"
method: GET
path: "/sso/v1/update-user"
tags: ["sso"]
---

# Update user details

`GET /sso/v1/update-user`

## Request

- Base URL: `https://www.spot.im/api`
- URL: `https://www.spot.im/api/sso/v1/update-user`
- Auth: none declared. Required headers: `x-spotim-sso-access-token`

Updates the OpenWeb user data of an existing SSO user

## Query parameters

- `primary_key` string, required
- `user_name` string, required
- `display_name` string
- `email` string
- `email_verified` boolean
- `image_url` string
- `location` string
- `private_profile` boolean
- `user_metadata` string

## Headers

- `x-spotim-sso-access-token` string, required

## Request body

- object
  - `bio` string: User bio When configuring a user bio, the bio cannot exceed 200 characters. This property can be passed with or without the `role` or `settings` object.
  - `role` 'admin' | 'community-moderator' | 'journalist' | 'moderator' | 'registered' | 'viewer': Permission level of the user **Possible values** - `admin`: Access to all sections of the system - `community-moderator`: Ability to moderate comments within a Conversation, but no Admin Panel access - `journalist`: Ability to select top comments, but no Admin Panel access - `moderator`: Access only to the moderation section - `registered`: Regular user with no assigned role (This is the default permission that is set when no role is specified.) - `viewer`: View-only access to the moderation section This property can be passed with or without the `bio` or `settings` object.
  - `settings` Settings: Email and in-app notification settings
    - `notifications` object: Notifications
      - `email` object
        - `liked_your_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `message_approved` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `message_rejected` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `replied_to_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `user_mentioned` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
      - `in_app` object
        - `liked_your_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `message_approved` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `message_rejected` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `replied_to_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `user_mentioned` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent

## Response `200`

- object
  - `success` boolean
  - `user` object
    - `bio` string: User bio When configuring a user bio, the bio cannot exceed 200 characters. This property can be passed with or without the `role` or `settings` object.
    - `display_name` string: **Non-unique** personal identifier used prominently throughout the platform A display name has the following characteristics: - Cannot exceed **30 characters** - Is comprised of a combination of letters, numbers, special characters, or spaces When not provided, OpenWeb creates a display name from the `user_name`.
    - `email` string: Email of the user
    - `email_verified` boolean: Indicates that the email of the user has been verified by the user **Possible Values**: - `false` (default) - `true` OpenWeb only sends email notifications to verified email addresses.
    - `image_url` string: URL of the profile image of the user This image is the avatar used for all comments created by the user. If the `image_url` is not set, OpenWeb selects a random avatar from the avatar scheme for the user. To delete a set user image, send an empty string for this parameter.
    - `is_blocked` string: Identifies if the user has permission to post comments on the site associated the spot ID **Possible Values**: - `false`: User has permission to post comments - `true`: User is on the blocked and restricted from posting comments - `null`: User’s access cannot be determined and the request should be attempted again
    - `location` string: Location of the user
    - `primary_key` string: Unique user ID generated by a Partner’s backend user management system
    - `private_profile` boolean: Indicates whether the user's commenting history and profile can be viewed by others **Possible Values**: - `false` (default) - `true`
    - `role` 'admin' | 'community-moderator' | 'journalist' | 'moderator' | 'registered' | 'viewer': Permission level of the user **Possible values** - `admin`: Access to all sections of the system - `community-moderator`: Ability to moderate comments within a Conversation, but no Admin Panel access - `journalist`: Ability to select top comments, but no Admin Panel access - `moderator`: Access only to the moderation section - `registered`: Regular user with no assigned role (This is the default permission that is set when no role is specified.) - `viewer`: View-only access to the moderation section This property can be passed with or without the `bio` or `settings` object.
    - `spotim_user_id` string
    - `user_metadata` UserMetadata
      - `is_subscriber` boolean: Indicates if the user is a subscriber or not and enables the segmentation of data by subscribers and non-subscribers
    - `user_name` string: Unique personal identifier used to differentiate between different users A username has the following characteristics: - Is **greater than 3 characters**, but **less than 30 characters** - Can be comprised of foreign-language characters - **Cannot** be comprised of delimiters, such as spaces, tabs, and other ASCII delimiters (`/t`, `/r`, and `/n`) - **Cannot** be comprised of special characters, such as `<` and `>` - Is preceded by the `@` symbol when displayed If a username is **already taken**, OpenWeb appends random letters or numbers to generate a unique version of that username and registers it to the user. If a username is **not provided**, OpenWeb creates a username from the `display_name`, appends random letters or numbers to generate a unique version of that username, and registers it to the user.
    - `settings` Settings: Email and in-app notification settings
      - `notifications` object: Notifications
        - `email` object
          - `liked_your_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
          - `message_approved` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
          - `message_rejected` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
          - `replied_to_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
          - `user_mentioned` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `in_app` object
          - `liked_your_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
          - `message_approved` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
          - `message_rejected` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
          - `replied_to_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
          - `user_mentioned` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent

---

[API](https://skmtc.dev/openweb/apis/single-sign-on-api.md) - [All operations](https://skmtc.dev/openweb/apis/single-sign-on-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openweb/apis/single-sign-on-api/revisions/a6965fc745e8?raw)