Skip to main content
PATCH
/
users
/
{user_id}
Update user details
curl --request PATCH \
  --url https://api.superthread.com/v1/users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "John",
  "last_name": "Smith",
  "display_name": "pete",
  "profile_image": "https://s3..../avatar.png",
  "thumbnail_image": "https://s3..../avatar.png",
  "color": "#023020",
  "signup_answers": {
    "role": "product_manager",
    "team_size": "1-10",
    "work_type": [
      "marketing",
      "design"
    ],
    "company_size": "1-10",
    "company_type": "startup",
    "company_department": "software_development",
    "hear_about_us": "word_of_mouth"
  },
  "timezone_id": "America/Los_Angeles",
  "autodetect_timezone_id": true,
  "locale": "en",
  "transcription_keywords": [
    "<string>"
  ],
  "job_description": "software engineer"
}
'
{
  "user": {
    "id": "u-dsu0j19",
    "email": "user@example.com",
    "email_confirmed": true,
    "first_name": "John",
    "last_name": "Smith",
    "display_name": "pete",
    "profile_image": "https://s3..../avatar.png",
    "thumbnail_image": "https://s3..../avatar.png",
    "color": "red",
    "status": "active",
    "teams": [
      {
        "archived": {
          "user_id": "uDsu0j19",
          "time_archived": 1608742037016
        },
        "id": "t-iwquhs1",
        "sub_domain": "apple",
        "team_name": "Apple Backend",
        "company_name": "Apple Inc",
        "email_domain": "apple.com",
        "creator_user_id": "u-dsu0j19",
        "time_created": 1608742037016,
        "time_updated": 1608742037016,
        "trashed": {
          "user_deleted": {
            "user_id": "uDsu0j19",
            "type": "user",
            "source": {
              "type": "oauth",
              "client_id": "oczapier",
              "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
              "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
              "email_addr": "somebody@example.com",
              "email_verified": false
            }
          },
          "time_deleted": 1608742037016
        },
        "subscription_plan_id": "free",
        "features": [
          {
            "id": "<string>",
            "enabled": true,
            "time_enabled": 1608742037016,
            "toggleable": true
          }
        ],
        "limits": [
          {
            "id": "<string>",
            "limit_value": "2"
          }
        ],
        "team_description": "Technology company",
        "role": "owner",
        "status": "active",
        "flags": [
          "ai0"
        ]
      }
    ],
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "current_project": "<string>",
    "timezone_id": "America/Los_Angeles",
    "autodetect_timezone_id": true,
    "locale": "en",
    "transcription_keywords": [
      "<string>"
    ],
    "job_description": "software engineer",
    "rank": 1
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
user_id
string
required

User ID is an alphanumerical string that identifies a user.

Body

application/json

User fields that need to be updated. All omitted fields are left unmodified.

​
first_name
string | null
Example:

"John"

​
last_name
string | null
Example:

"Smith"

​
display_name
string | null
Minimum string length: 1
Example:

"pete"

​
profile_image
string | null
Example:

"https://s3..../avatar.png"

​
thumbnail_image
string | null
Example:

"https://s3..../avatar.png"

​
color
string | null
Example:

"#023020"

​
signup_answers
object
​
timezone_id
string
Example:

"America/Los_Angeles"

​
autodetect_timezone_id
boolean | null
Example:

true

​
locale
string | null
Example:

"en"

​
transcription_keywords
string[] | null
​
job_description
string | null
Example:

"software engineer"

Response

updated user response

​
user
User · object