Sign in
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}

Path parameters

actorIdstring required

The integer ID of the User.

Response

OK

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

Changes

Changed in 3 of the 54 revisions of this API.4

  • 022694254f0d1See the full diff
    • ○

      api operation id Modifying a User removed and replaced with modifyUser

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • e8c2858fd4eb2See the full diff
    • ○

      api operation id modifyUser removed and replaced with Modifying a User

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog