v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0118684573.2 KB

Users

Modifying a User

You can PATCH JSON data to update User details. Not all user information is modifiable; right now, the following fields may be updated:

displayName sets the friendly display name the web interface uses to refer to the user.
email sets the email address associated with the account.

When user details are updated, the updatedAt field will be automatically updated.

patch/v1/users/{actorId}

actorIdstring required

The integer ID of the User.

createdAtstring required

ISO date format

displayNamestring required

All Actors, regardless of type, have a display name

idnumber required

type'user' | 'field_key' | 'public_link' | 'singleUse' required

the Type of this Actor; typically this will be user.

updatedAtstring

ISO date format

deletedAtstring

ISO date format

emailstring required

Only Users have email addresses associated with them