Update a User
curl --request PATCH \
--url https://api.example.com/v1/users/{user_id}/import requests
url = "https://api.example.com/v1/users/{user_id}/"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.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.example.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",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/users/{user_id}/"
req, _ := http.NewRequest("PATCH", url, nil)
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.example.com/v1/users/{user_id}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/users/{user_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyUsers
Update a User
Update an existing user’s information within the Transcrypts system.
PATCH
/
v1
/
users
/
{user_id}
/
Update a User
curl --request PATCH \
--url https://api.example.com/v1/users/{user_id}/import requests
url = "https://api.example.com/v1/users/{user_id}/"
response = requests.patch(url)
print(response.text)const options = {method: 'PATCH'};
fetch('https://api.example.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.example.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",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/users/{user_id}/"
req, _ := http.NewRequest("PATCH", url, nil)
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.example.com/v1/users/{user_id}/")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/users/{user_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
response = http.request(request)
puts response.read_bodyOverview
This endpoint enables updating an existing user’s information within the Transcrypts system.Request
Endpoint
PATCH https://prod.transcrypts.com/v1/users/{user_id}/
Authentication
API authentication requires the following headers:| Header | Description |
|---|---|
X-Access-Client-Id | Your Client ID |
X-Access-Secret | Your Access Key |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | The unique identifier for the user being updated |
Request Body
The request accepts JSON with user profile fields that can be modified.| Parameter | Type | Required | Description |
|---|---|---|---|
external_user_id | string | No | External user identifier |
first_name | string | No | User’s first name |
last_name | string | No | User’s last name |
email | string | No | User’s email address |
phone | string | No | User’s phone number |
ssn | string | No | User’s Social Security Number |
Example Request
{
"first_name": "Jane",
"last_name": "Doe"
}
Response
Success Response (HTTP 200)
The endpoint returns the updated user object upon successful modification.{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_user_id": "12345",
"first_name": "Jane",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "+14155554193",
"ssn": "222233333",
"created_at": "2022-05-04T11:30:00Z",
"updated_at": "2022-05-04T13:00:00Z"
}
Error Responses
| Status Code | Description |
|---|---|
| 400 | Bad Request - Incorrect parameters provided |
| 401 | Unauthorized - Missing or invalid authentication credentials |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - User does not exist |