Skip to main content
PATCH
Change user email

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

User identifier

Body

application/merge-patch+json

The updated User resource

The body is of type object.

Response

User resource updated

id
integer
read-only
firstName
string | null
Maximum string length: 255
lastName
string | null
Maximum string length: 255
email
string<email> | null
newEmailRequested
string<email> | null
isGuest
boolean
read-only
resignPending
integer | null
read-only
resignApproved
integer | null
read-only
dateBirth
string<date-time> | null
age
integer | null
read-only
fullName
string
read-only
accountType
string | null
default:self-managed
roles
(string | null)[]
customFieldValues
object[]
logo
string | null
phoneNumber
string | null
isFollowGeneralUnit
boolean | null
default:true
roleGroups
(string | null)[] | null
isSupporter
boolean | null
identity
object | null
adhesion
object | null
bio
string | null
postalCode
string | null
address
string | null
phoneLocalNumber
string | null
read-only
pushNotificationTokens
object[]
permissions
(string | null)[] | null
customPermissions
(string | null)[] | null
privacy
object | null
notificationSettings
(string | null)[] | null
isSubscribedNewsletter
boolean | null
isSubscribedPush
boolean | null
isSubscribedDiscussion
integer | null
isSubscribedEvent
boolean | null
isSubscribedComment
boolean | null
isSubscribedIssue
boolean | null
isSubscribedVote
boolean | null
isSubscribedTag
boolean | null
professionOrganisation
string | null
professionOrganisationWebsite
string | null
professionOrganisationRole
string | null
companyIdentifier
string | null
companyName
string | null
companyAddress
string | null
companyRegNo
string | null
mfaEnabled
boolean | null