Sign in

v51

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

Setting Actor Property Values on an App User

Sets or unsets pre-registered Actor Property values on an App User. The body must contain a properties object mapping property names to string values or null. Sending null for a property unsets it.

Returns the extended App User, including a properties object containing all currently set property values.

Requires field_key.update permission.

patch/v1/projects/{projectId}/app-users/{id}

Path parameters

idnumber required

The numeric ID of the App User

projectIdnumber required

The numeric ID of the Project

Request body

propertiesobject

An object mapping actor property names to string values or null. Set a property by providing a string value; unset it by providing null.

Example request

{
  "properties": {
    "region": "North",
    "supervisor": null
  }
}

Response

Returns the extended App User with the updated properties.

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 actor

updatedAtstring

ISO date format

deletedAtstring

ISO date format

tokenstring

If present, this is the Token that can be used to authenticate a request as this App User. If not present, this App User's access has been revoked.

projectIdnumber

The ID of the Project that this App User is bound to.

lastUsedstring

ISO date format. The last time this App User was used to authenticate a request.

propertiesobject nullable

An object mapping actor property names to their currently set string values for this App User. Only properties with values set are included. null if no properties have been set.

Example response

{
  "createdAt": "2018-04-18T23:19:14.802Z",
  "displayName": "My Display Name",
  "id": 115,
  "updatedAt": "2018-04-18T23:42:11.406Z",
  "deletedAt": "2018-04-18T23:42:11.406Z",
  "token": "d1!E2GVHgpr4h9bpxxtqUJ7EVJ1Q$Dusm2RBXg8XyVJMCBCbvyE8cGacxUx3bcUT",
  "projectId": 1,
  "createdBy": {
    "createdAt": "2018-04-18T23:19:14.802Z",
    "displayName": "My Display Name",
    "id": 115,
    "updatedAt": "2018-04-18T23:42:11.406Z",
    "deletedAt": "2018-04-18T23:42:11.406Z"
  },
  "lastUsed": "2018-04-14T08:34:21.633Z",
  "properties": {
    "region": "North",
    "supervisor": "Alice"
  }
}