Skip to content
API Reference
/
/
Update a user

Update a user

Request

Security
form_session or user_session or component_session or component_token or api_token
Path
user_idstring(UserId)^user_required

User Identifier

Bodyapplication/jsonrequired
external_idstring or null
Any of:

Optional field to store a customer-provided identifier for the user. Onboarded does not validate uniqueness of this field. Customers who intend to use this field with magic links should ensure this field holds unique values.

string
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/users/{user_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "string"
  }'

Responses

User

Bodyapplication/json
idstring(UserId)^user_required

User Identifier

emailstringrequired
external_idstring or nullrequired
Any of:
string
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

Response
{
  "id": "user_abc123def456",
  "email": "string",
  "external_id": "string",
  "created_at": "string",
  "updated_at": "string"
}