Logto API references

Update user profile

PATCH /api/users/{userId}/profile

Update profile for the given user ID. This method performs a partial update of the profile object.

Path parameters

userId string Required

The unique identifier of the user.

application/json

Body Required

profile object Required

Partial profile object to update for the given user ID.
Hide profile attributes Show profile attributes
- familyName string
- givenName string
- middleName string
- nickname string
- preferredUsername string
- profile string
- website string
- gender string
- birthdate string
- zoneinfo string
- locale string
- address object
  Hide address attributes Show address attributes
  
  formatted string
  
  streetAddress string
  
  locality string
  
  region string
  
  postalCode string
  
  country string

Responses

• 200 application/json

Updated profile in JSON for the given user ID.
Hide response attributes Show response attributes object
- familyName string
- givenName string
- middleName string
- nickname string
- preferredUsername string
- profile string
- website string
- gender string
- birthdate string
- zoneinfo string
- locale string
- address object
  
  Hide address attributes Show address attributes
  
  formatted string
  
  streetAddress string
  
  locality string
  
  region string
  
  postalCode string
  
  country string
• 400

Bad Request
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found

PATCH /api/users/{userId}/profile

curl \
 -X PATCH https://[tenant_id].logto.app/api/users/{userId}/profile \
 -H "Content-Type: application/json" \
 -d '{"profile":{"familyName":"string","givenName":"string","middleName":"string","nickname":"string","preferredUsername":"string","profile":"string","website":"string","gender":"string","birthdate":"string","zoneinfo":"string","locale":"string","address":{"formatted":"string","streetAddress":"string","locality":"string","region":"string","postalCode":"string","country":"string"}}}'

Request example

{
  "profile": {
    "familyName": "string",
    "givenName": "string",
    "middleName": "string",
    "nickname": "string",
    "preferredUsername": "string",
    "profile": "string",
    "website": "string",
    "gender": "string",
    "birthdate": "string",
    "zoneinfo": "string",
    "locale": "string",
    "address": {
      "formatted": "string",
      "streetAddress": "string",
      "locality": "string",
      "region": "string",
      "postalCode": "string",
      "country": "string"
    }
  }
}

Response examples (200)

{
  "familyName": "string",
  "givenName": "string",
  "middleName": "string",
  "nickname": "string",
  "preferredUsername": "string",
  "profile": "string",
  "website": "string",
  "gender": "string",
  "birthdate": "string",
  "zoneinfo": "string",
  "locale": "string",
  "address": {
    "formatted": "string",
    "streetAddress": "string",
    "locality": "string",
    "region": "string",
    "postalCode": "string",
    "country": "string"
  }
}