Skip to main content

UpdateMemberRequestDto

The request parameters for updating the user information.

NameTypeDescriptionNotes
userIdStringThe account the change applies to. It is read from this body by POST api/2.0/people/email, while PUT api/2.0/people/{userId} takes the account from the route and ignores this field.[optional] [example: 00000000-0000-0000-0000-000000000000] [nullable]
disableBooleanSet it to true to give the account the Terminated status and end every session it has, and to false to bring it back. It is applied only when the caller edits somebody else, and omitting it keeps the current status.[optional] [example: false] [nullable]
emailString (email)The new email address, up to 255 characters. It is read only by POST api/2.0/people/email, which either mails a confirmation letter or, for an administrator acting on somebody else, applies the address at once; PUT api/2.0/people/{userId} ignores it.[optional] [example: john.doe@example.com] [minLength: 0] [maxLength: 255] [nullable]
isUserBooleanSet it to true to turn the account into a guest and to false to turn it back into a member. Either direction takes a seat and can answer 402, it is applied only when the caller edits somebody else, and a request to make the portal owner, a DocSpace administrator or a module administrator a guest is ignored.[optional] [example: true] [nullable]
firstNameStringThe new first name, up to 255 characters. It is applied only to the caller's own profile, is left alone on an LDAP or SSO account, and a pair the portal does not accept as a name answers 400.[optional] [example: John] [minLength: 0] [maxLength: 255] [nullable]
lastNameStringThe new last name, up to 255 characters. It is applied only to the caller's own profile, is left alone on an LDAP or SSO account, and a pair the portal does not accept as a name answers 400.[optional] [example: Doe] [minLength: 0] [maxLength: 255] [nullable]
departmentList (uuid)The groups the profile should belong to, by group ID, replacing the current ones. It is applied only to the caller's own profile.[optional] [example: [00000000-0000-0000-0000-000000000000]] [nullable]
locationStringThe new free-text location shown on the profile. It is applied only to the caller's own profile and is left alone on an LDAP or SSO account.[optional] [example: New York] [nullable]
commentStringThe new free-text note kept with the profile. It is applied only to the caller's own profile.[optional] [example: User comment] [nullable]
contactsListThe additional ways to reach the person, replacing the current ones. Each entry is a free-text type such as email, phone, skype or telegram and its value, an entry with an empty value is dropped, and the field is applied only to the caller's own profile.[optional] [example: [{type=email, value=john.doe@example.com}]] [nullable]
filesStringThe address the portal downloads the new avatar from. It is applied only to the caller's own profile, has to use HTTPS unless the request itself came over HTTP, and passing the address the profile already uses downloads nothing.[optional] [example: https://example.com/avatar.jpg] [nullable]
spamBooleanWhether the account agrees to receive tips, updates and offers. It is applied only to the caller's own profile, and omitting it on such a request stores false rather than keeping the current value.[optional] [example: false] [nullable]