Skip to main content
PATCH
/
api
/
v1
/
users
/
{id}
/
new-email
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "<string>",
  "id": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "newEmailRequested": "jsmith@example.com",
  "isGuest": true,
  "resignPending": 123,
  "resignApproved": 123,
  "dateBirth": "2023-11-07T05:31:56Z",
  "age": 123,
  "fullName": "<string>",
  "roles": [
    "ROLE_USER"
  ],
  "customFieldValues": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "field": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "name": "<string>",
        "isOnlyAdmin": true
      },
      "value": "<string>"
    }
  ],
  "logo": "<string>",
  "phoneNumber": "<string>",
  "isFollowGeneralUnit": true,
  "roleGroups": [
    "<string>"
  ],
  "isSupporter": true,
  "hasDigestDaily": true,
  "identity": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "idAddress": "<string>",
    "status": "<string>",
    "addressStreet": "<string>",
    "addressDetails": "<string>",
    "idTown": "https://example.com/",
    "media": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "entityId": 123,
      "contentUrl": "<string>",
      "type": "<string>"
    },
    "mediaBack": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "entityId": 123,
      "contentUrl": "<string>",
      "type": "<string>"
    }
  },
  "adhesion": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "status": "pending",
    "medias": [
      {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "entityId": 123,
        "contentUrl": "<string>",
        "type": "<string>"
      }
    ]
  },
  "postalCode": "<string>",
  "address": "<string>",
  "phoneLocalNumber": "<string>",
  "pushNotificationTokens": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "mobileOneSignalSubscriptionId": "<string>",
      "deviceId": "<string>",
      "deviceType": "<string>"
    }
  ],
  "permissions": [
    "<string>"
  ],
  "customPermissions": [
    "<string>"
  ],
  "privacy": {
    "age": true,
    "name": false,
    "email": true,
    "phone": true,
    "social": false,
    "image": false,
    "town": false,
    "profession": false
  },
  "apiToken": "<string>",
  "notificationSettings": {
    "prefTheme": "light",
    "prefWelcomeRead": false,
    "pPrivacyRead": false,
    "pGroups": false,
    "pNotificationRead": false,
    "pTimezoneRead": false,
    "pAdhesionRead": false
  },
  "professionOrganisation": "<string>",
  "professionOrganisationRole": "<string>",
  "hasDigestWeekly": true,
  "companyIdentifier": "<string>",
  "companyName": "<string>",
  "companyAddress": "<string>",
  "companyRegNo": "<string>",
  "mfaEnabled": true
}

Path Parameters

​
id
string
required

User identifier

Body

application/merge-patch+json · object

The updated User resource

Response

User resource updated

​
@context
​
@id
string
​
@type
string
​
id
integer
​
firstName
string | null
​
lastName
string | null
​
email
string<email> | null
​
newEmailRequested
string<email> | null
​
isGuest
boolean
​
resignPending
integer | null
​
resignApproved
integer | null
​
dateBirth
string<date-time> | null
​
age
integer | null
​
fullName
string
​
roles
string[]
Example:
["ROLE_USER"]
​
customFieldValues
object[]
​
phoneNumber
string | null
​
isFollowGeneralUnit
boolean | null
default:true
Example:

true

​
roleGroups
string[] | null
​
isSupporter
boolean | null
​
hasDigestDaily
boolean | null
​
identity
object | null
​
adhesion
object | null
​
postalCode
string | null
​
address
string | null
​
phoneLocalNumber
string | null
​
pushNotificationTokens
object[]
​
permissions
string[] | null
​
customPermissions
string[] | null
​
privacy
string[] | null
Example:
{
  "age": true,
  "name": false,
  "email": true,
  "phone": true,
  "social": false,
  "image": false,
  "town": false,
  "profession": false
}
​
apiToken
string | null
​
notificationSettings
string[] | null
Example:
{
  "prefTheme": "light",
  "prefWelcomeRead": false,
  "pPrivacyRead": false,
  "pGroups": false,
  "pNotificationRead": false,
  "pTimezoneRead": false,
  "pAdhesionRead": false
}
​
professionOrganisation
string | null
​
professionOrganisationRole
string | null
​
hasDigestWeekly
boolean | null
​
companyIdentifier
string | null
​
companyName
string | null
​
companyAddress
string | null
​
companyRegNo
string | null
​
mfaEnabled
boolean | null
⌘I