Users

Upsert user

Update or insert user account. If an account with the specified uid is found it is updated, otherwise it is created.

put/api/users/{uid}

Request

  • Base URL: https://docs.weavy.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.weavy.com/api/users/{uid}
  • Auth: none declared

Path parameters

uidstring required

Unique identifier.

Request body

uidstring nullable

Unique user identifier (cannot contain whitespace and must contain at least one non-digit).

namestring nullable

The full name in displayable form including all name parts, possibly including titles and suffixes.

given_namestring nullable

Given/First name(s) of user. In some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.

middle_namestring nullable

Middle name(s) of the user. In some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters.

family_namestring nullable

Family/Last name(s) of user. In some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.

nicknamestring nullable

The nickname, a casual name that may or may not be the same as the string UserUp.GivenName. For instance, a person with given name "Michael" might have the nickname "Mike".

emailstring nullable

Email address.

phone_numberstring nullable

The user's preferred phone number.

usernamestring nullable

The username for authentication.

passwordstring nullable

The user's password for authentication.

commentstring nullable

Comment or other application-specific information about the user.

picturestring nullable

The user's profile picture. Can be a public URL, a base64 encoded data URI or a blob id.

directoriesstring[] nullable

Ids or names of user directories.

metadataobject nullable

Additional metadata properties, e.g. { "color": "blue", "size": "XL" }.

tagsstring[] nullable

A list of tags to associate with the user.

Response

OK

uidstring nullable
namestring nullable
given_namestring nullable
middle_namestring nullable
family_namestring nullable
nicknamestring nullable
emailstring nullable
phone_numberstring nullable
usernamestring nullable
avatar_urlstring nullable

Url to profile picture for user.

presenceunknown
commentstring nullable
metadataobject nullable
tagsstring[] nullable
created_atstring date-time nullable
updated_atstring date-time nullable
is_followedboolean nullable

Indicates whether the user account is followed by the authenticated user.

is_trashedboolean nullable

Indicates whether the user account is trashed.

Changes

No recorded changes to this operation across all 1 revision of this API.