Skip to main content
PATCH
/
v1
/
users
/
{user_id}
Update a User
curl --request PATCH \
  --url https://api.example.com/v1/users/{user_id}/

​
Overview

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:
HeaderDescription
X-Access-Client-IdYour Client ID
X-Access-SecretYour Access Key

​
Path Parameters

ParameterTypeRequiredDescription
user_idstringYesThe unique identifier for the user being updated

​
Request Body

The request accepts JSON with user profile fields that can be modified.
ParameterTypeRequiredDescription
external_user_idstringNoExternal user identifier
first_namestringNoUser’s first name
last_namestringNoUser’s last name
emailstringNoUser’s email address
phonestringNoUser’s phone number
ssnstringNoUser’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 CodeDescription
400Bad Request - Incorrect parameters provided
401Unauthorized - Missing or invalid authentication credentials
403Forbidden - Insufficient permissions
404Not Found - User does not exist