Skip to main content
PUT
/
api
/
v1
/
users
/
{user_id}
Update user
curl --request PUT \
  --url http://localhost:9001/api/v1/users/{user_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "external_id": "<string>",
  "name": "<string>",
  "profile_pic_url": "<string>",
  "status": "ACTIVE",
  "is_verified": true,
  "metadata": {},
  "authentication_type": "google-oauth2",
  "authentication_partner": "AUTH0",
  "authentication_partner_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
'
{
  "message": "user updated successfully"
}

Authorizations

Authorization
string
header
required

JWT token from Auth0

Headers

x-account-id
string
required

Account external ID for context

Example:

"acct-xyz789-v1"

Path Parameters

user_id
string<uuid>
required

User's internal UUID

Body

application/json
id
string<uuid>
email
string<email>
external_id
string
name
string
profile_pic_url
string<uri>
status
enum<string>

User account status

Available options:
ACTIVE,
INACTIVE,
SUSPENDED,
WAITLISTED,
INVITED,
PENDING
is_verified
boolean
metadata
object
authentication_type
enum<string>

Type of authentication used

Available options:
google-oauth2,
auth0,
github,
unknown
authentication_partner
enum<string>

Authentication provider

Available options:
AUTH0
authentication_partner_id
string
created_at
string<date-time>
updated_at
string<date-time>

Response

User updated successfully

message
string
Example:

"user updated successfully"