Users

Modifying a User

Changed on

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}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/users/{actorId}
  • Auth
    none declared

Path parameters

actorIdstring required

The integer ID of the User.

Request body */*

displayNamestring

The friendly display name that should be associated with this User.

emailstring

The email address that should be associated with this User.

Example request

{
  "displayName": "New Name",
  "email": "new.email.address@getodk.org"
}

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