---
title: "Setting Actor Property Values on an App User"
method: PATCH
path: "/v1/projects/{projectId}/app-users/{id}"
tags: ["App Users"]
---

# Setting Actor Property Values on an App User

`PATCH /v1/projects/{projectId}/app-users/{id}`

Sets or unsets pre-registered [Actor Property](/central-api-accounts-and-users/#actor-properties) 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.

## Path parameters

- `id` number, required
- `projectId` number, required

## Request body

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

## Response `200`

Returns the extended App User with the updated properties.

- ExtendedAppUser
  - `createdAt` string, required — ISO date format
  - `displayName` string, required — All `Actor`s, regardless of type, have a display name
  - `id` number, required
  - `type` 'user' | 'field_key' | 'public_link' | 'singleUse', required — The type of actor
  - `updatedAt` string — ISO date format
  - `deletedAt` string — ISO date format
  - `token` string — 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.
  - `projectId` number — The ID of the `Project` that this `App User` is bound to.
  - `createdBy` Actor
    - `createdAt` string, required — ISO date format
    - `displayName` string, required — All `Actor`s, regardless of type, have a display name
    - `id` number, required
    - `type` 'user' | 'field_key' | 'public_link' | 'singleUse', required — The type of actor
    - `updatedAt` string — ISO date format
    - `deletedAt` string — ISO date format
  - `lastUsed` string — ISO date format. The last time this `App User` was used to authenticate a request.
  - `properties` object, 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.

---

[API](https://skmtc.net/getodk/apis/odk-central-api.md) · [All operations](https://skmtc.net/getodk/apis/odk-central-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getodk/odk-central-api/versions/d8f5a0886a8b/schema)