Update other profile

PATCH /api/profile/profile

Update other profile for the user, only the fields that are passed in will be updated, to update the address, the user must have the address scope.

application/json

Body Required

familyName string

The new family name for the user.
givenName string

The new given name for the user.
middleName string

The new middle name for the user.
nickname string

The new nickname for the user.
preferredUsername string

The new preferred username for the user.
profile string

The new profile for the user.
website string

The new website for the user.
gender string

The new gender for the user.
birthdate string

The new birthdate for the user.
zoneinfo string

The new zoneinfo for the user.
locale string

The new locale for the user.
address object

The new address for the user.
Hide address attributes Show address attributes object
- formatted string
- streetAddress string
- locality string
- region string
- postalCode string
- country string

Responses

200 application/json

The profile was updated successfully.
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 object
  
  formatted string
  
  streetAddress string
  
  locality string
  
  region string
  
  postalCode string
  
  country string
400

Bad Request
401

Unauthorized
403

Forbidden

PATCH /api/profile/profile

curl \
 -X PATCH https://[tenant_id].logto.app/api/profile/profile \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"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 examples

{
  "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"
  }
}