Users
Update my account
Updates user profile fields such as name, profile image, timezone, and company information. Allows selective updates, leaving unspecified fields unmodified. A successful request returns the updated user details.
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"
}
'import requests
url = "https://api.superthread.com/v1/users/{user_id}"
payload = {
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.superthread.com/v1/users/{user_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.superthread.com/v1/users/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.superthread.com/v1/users/{user_id}"
payload := strings.NewReader("{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"display_name\": \"pete\",\n \"profile_image\": \"https://s3..../avatar.png\",\n \"thumbnail_image\": \"https://s3..../avatar.png\",\n \"color\": \"#023020\",\n \"signup_answers\": {\n \"role\": \"product_manager\",\n \"team_size\": \"1-10\",\n \"work_type\": [\n \"marketing\",\n \"design\"\n ],\n \"company_size\": \"1-10\",\n \"company_type\": \"startup\",\n \"company_department\": \"software_development\",\n \"hear_about_us\": \"word_of_mouth\"\n },\n \"timezone_id\": \"America/Los_Angeles\",\n \"autodetect_timezone_id\": true,\n \"locale\": \"en\",\n \"transcription_keywords\": [\n \"<string>\"\n ],\n \"job_description\": \"software engineer\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.superthread.com/v1/users/{user_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"display_name\": \"pete\",\n \"profile_image\": \"https://s3..../avatar.png\",\n \"thumbnail_image\": \"https://s3..../avatar.png\",\n \"color\": \"#023020\",\n \"signup_answers\": {\n \"role\": \"product_manager\",\n \"team_size\": \"1-10\",\n \"work_type\": [\n \"marketing\",\n \"design\"\n ],\n \"company_size\": \"1-10\",\n \"company_type\": \"startup\",\n \"company_department\": \"software_development\",\n \"hear_about_us\": \"word_of_mouth\"\n },\n \"timezone_id\": \"America/Los_Angeles\",\n \"autodetect_timezone_id\": true,\n \"locale\": \"en\",\n \"transcription_keywords\": [\n \"<string>\"\n ],\n \"job_description\": \"software engineer\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.superthread.com/v1/users/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"display_name\": \"pete\",\n \"profile_image\": \"https://s3..../avatar.png\",\n \"thumbnail_image\": \"https://s3..../avatar.png\",\n \"color\": \"#023020\",\n \"signup_answers\": {\n \"role\": \"product_manager\",\n \"team_size\": \"1-10\",\n \"work_type\": [\n \"marketing\",\n \"design\"\n ],\n \"company_size\": \"1-10\",\n \"company_type\": \"startup\",\n \"company_department\": \"software_development\",\n \"hear_about_us\": \"word_of_mouth\"\n },\n \"timezone_id\": \"America/Los_Angeles\",\n \"autodetect_timezone_id\": true,\n \"locale\": \"en\",\n \"transcription_keywords\": [\n \"<string>\"\n ],\n \"job_description\": \"software engineer\"\n}"
response = http.request(request)
puts response.read_body{
"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",
"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,
"on_behalf_of": "<string>"
}
},
"time_deleted": 1608742037016
},
"logo": {
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"subscription_plan_id": "free",
"features": [
{
"id": "<string>",
"enabled": true,
"time_enabled": 1608742037016,
"toggleable": true
}
],
"limits": [
{
"id": "<string>",
"limit_value": "2"
}
],
"team_description": "Technology company",
"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
}
}{
"error": {
"id": "err5f744ab",
"code": 403,
"sec": "SEC:000-00014",
"message": "You do not have access to this resource",
"date": 1608742037016
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
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.
Example:
"John"
Example:
"Smith"
Minimum string length:
1Example:
"pete"
Example:
"https://s3..../avatar.png"
Example:
"https://s3..../avatar.png"
Example:
"#023020"
Show child attributes
Show child attributes
Example:
"America/Los_Angeles"
Example:
true
Example:
"en"
Example:
"software engineer"
Response
updated user response
Show child attributes
Show child attributes
Previous
Get team membersReturns a list of all members belonging to a specified team (workspace),
along with their roles and other relevant details.
Next
⌘I
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"
}
'import requests
url = "https://api.superthread.com/v1/users/{user_id}"
payload = {
"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"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.superthread.com/v1/users/{user_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.superthread.com/v1/users/{user_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.superthread.com/v1/users/{user_id}"
payload := strings.NewReader("{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"display_name\": \"pete\",\n \"profile_image\": \"https://s3..../avatar.png\",\n \"thumbnail_image\": \"https://s3..../avatar.png\",\n \"color\": \"#023020\",\n \"signup_answers\": {\n \"role\": \"product_manager\",\n \"team_size\": \"1-10\",\n \"work_type\": [\n \"marketing\",\n \"design\"\n ],\n \"company_size\": \"1-10\",\n \"company_type\": \"startup\",\n \"company_department\": \"software_development\",\n \"hear_about_us\": \"word_of_mouth\"\n },\n \"timezone_id\": \"America/Los_Angeles\",\n \"autodetect_timezone_id\": true,\n \"locale\": \"en\",\n \"transcription_keywords\": [\n \"<string>\"\n ],\n \"job_description\": \"software engineer\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.superthread.com/v1/users/{user_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"display_name\": \"pete\",\n \"profile_image\": \"https://s3..../avatar.png\",\n \"thumbnail_image\": \"https://s3..../avatar.png\",\n \"color\": \"#023020\",\n \"signup_answers\": {\n \"role\": \"product_manager\",\n \"team_size\": \"1-10\",\n \"work_type\": [\n \"marketing\",\n \"design\"\n ],\n \"company_size\": \"1-10\",\n \"company_type\": \"startup\",\n \"company_department\": \"software_development\",\n \"hear_about_us\": \"word_of_mouth\"\n },\n \"timezone_id\": \"America/Los_Angeles\",\n \"autodetect_timezone_id\": true,\n \"locale\": \"en\",\n \"transcription_keywords\": [\n \"<string>\"\n ],\n \"job_description\": \"software engineer\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.superthread.com/v1/users/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"John\",\n \"last_name\": \"Smith\",\n \"display_name\": \"pete\",\n \"profile_image\": \"https://s3..../avatar.png\",\n \"thumbnail_image\": \"https://s3..../avatar.png\",\n \"color\": \"#023020\",\n \"signup_answers\": {\n \"role\": \"product_manager\",\n \"team_size\": \"1-10\",\n \"work_type\": [\n \"marketing\",\n \"design\"\n ],\n \"company_size\": \"1-10\",\n \"company_type\": \"startup\",\n \"company_department\": \"software_development\",\n \"hear_about_us\": \"word_of_mouth\"\n },\n \"timezone_id\": \"America/Los_Angeles\",\n \"autodetect_timezone_id\": true,\n \"locale\": \"en\",\n \"transcription_keywords\": [\n \"<string>\"\n ],\n \"job_description\": \"software engineer\"\n}"
response = http.request(request)
puts response.read_body{
"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",
"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,
"on_behalf_of": "<string>"
}
},
"time_deleted": 1608742037016
},
"logo": {
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"subscription_plan_id": "free",
"features": [
{
"id": "<string>",
"enabled": true,
"time_enabled": 1608742037016,
"toggleable": true
}
],
"limits": [
{
"id": "<string>",
"limit_value": "2"
}
],
"team_description": "Technology company",
"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
}
}{
"error": {
"id": "err5f744ab",
"code": 403,
"sec": "SEC:000-00014",
"message": "You do not have access to this resource",
"date": 1608742037016
}
}