---
title: "PUT /api/admin/user-properties/"
method: PUT
path: "/api/admin/user-properties/"
tags: ["User Properties"]
---

# PUT /api/admin/user-properties/

`PUT /api/admin/user-properties/`

Create or update a user property.

## Request body

- object
  - `id` string
  - `workspaceId` string, required
  - `definition` union — A user property definition.
    - object — A user property definition that resolves to a user's id.
      - `type` 'Id', required
    - object — A user property definition that resolves to a user's anonymous id.
      - `type` 'AnonymousId', required
    - object — A user property definition that is a parent of other user property definitions.
      - `type` 'Group', required
      - `entry` string, required
      - `nodes` union[], required
        - union — A user property definition that is a child of a group user property definition.
          - object — A user property definition that resolves to the first matching user property definition.
            - `id` string, required
            - `type` 'AnyOf', required
            - `children` string[], required
          - object — A user property definition that resolves to a matching trait.
            - `id` string
            - `type` 'Trait', required
            - `path` string, required
          - object — A user property definition that renders the last matching track event.
            - `id` string
            - `type` 'Performed', required
            - `event` string, required
            - `path` string, required
            - `skipReCompute` boolean
            - `properties` object[]
              - …
          - object — A user property definition that resolves to a file.
            - `id` string
            - `type` 'File', required
            - `skipReCompute` boolean
            - `name` string, required
          - object — A user property definition that renders the last matching track event with a given key. Used in event entry journeys.
            - `id` string
            - `type` 'KeyedPerformed', required
            - `event` string, required
            - `path` string, required
            - `key` string, required
            - `properties` object[]
              - …
    - object — A user property definition that resolves to a matching trait.
      - `id` string
      - `type` 'Trait', required
      - `path` string, required
    - object — A user property definition that renders the last matching track event.
      - `id` string
      - `type` 'Performed', required
      - `event` string, required
      - `path` string, required
      - `skipReCompute` boolean
      - `properties` object[]
        - `path` string, required
        - `operator` object, required
          - `type` 'Equals', required
          - `value` string, required
    - object — A user property definition that resolves to a file.
      - `id` string
      - `type` 'File', required
      - `skipReCompute` boolean
      - `name` string, required
    - object — A user property definition that renders the last matching track event with a given key. Used in event entry journeys.
      - `id` string
      - `type` 'KeyedPerformed', required
      - `event` string, required
      - `path` string, required
      - `key` string, required
      - `properties` object[]
        - `path` string, required
        - `operator` object, required
          - `type` 'Equals', required
          - `value` string, required
    - object — A user property definition that renders all matching track events.
      - `id` string
      - `type` 'PerformedMany', required
      - `or` object[], required
        - `event` string, required
  - `exampleValue` string
  - `updatedAt` number
  - `lastRecomputed` number
  - `status` union
    - 'NotStarted'
    - 'Running'
    - 'Paused'
  - `name` string, required

## Response `200`

Default Response

- object
  - `id` string, required
  - `workspaceId` string, required
  - `name` string, required
  - `definition` union, required — A user property definition.
    - object — A user property definition that resolves to a user's id.
      - `type` 'Id', required
    - object — A user property definition that resolves to a user's anonymous id.
      - `type` 'AnonymousId', required
    - object — A user property definition that is a parent of other user property definitions.
      - `type` 'Group', required
      - `entry` string, required
      - `nodes` union[], required
        - union — A user property definition that is a child of a group user property definition.
          - object — A user property definition that resolves to the first matching user property definition.
            - `id` string, required
            - `type` 'AnyOf', required
            - `children` string[], required
          - object — A user property definition that resolves to a matching trait.
            - `id` string
            - `type` 'Trait', required
            - `path` string, required
          - object — A user property definition that renders the last matching track event.
            - `id` string
            - `type` 'Performed', required
            - `event` string, required
            - `path` string, required
            - `skipReCompute` boolean
            - `properties` object[]
              - …
          - object — A user property definition that resolves to a file.
            - `id` string
            - `type` 'File', required
            - `skipReCompute` boolean
            - `name` string, required
          - object — A user property definition that renders the last matching track event with a given key. Used in event entry journeys.
            - `id` string
            - `type` 'KeyedPerformed', required
            - `event` string, required
            - `path` string, required
            - `key` string, required
            - `properties` object[]
              - …
    - object — A user property definition that resolves to a matching trait.
      - `id` string
      - `type` 'Trait', required
      - `path` string, required
    - object — A user property definition that renders the last matching track event.
      - `id` string
      - `type` 'Performed', required
      - `event` string, required
      - `path` string, required
      - `skipReCompute` boolean
      - `properties` object[]
        - `path` string, required
        - `operator` object, required
          - `type` 'Equals', required
          - `value` string, required
    - object — A user property definition that resolves to a file.
      - `id` string
      - `type` 'File', required
      - `skipReCompute` boolean
      - `name` string, required
    - object — A user property definition that renders the last matching track event with a given key. Used in event entry journeys.
      - `id` string
      - `type` 'KeyedPerformed', required
      - `event` string, required
      - `path` string, required
      - `key` string, required
      - `properties` object[]
        - `path` string, required
        - `operator` object, required
          - `type` 'Equals', required
          - `value` string, required
    - object — A user property definition that renders all matching track events.
      - `id` string
      - `type` 'PerformedMany', required
      - `or` object[], required
        - `event` string, required
  - `exampleValue` string
  - `updatedAt` number, required
  - `lastRecomputed` number
  - `status` union
    - 'NotStarted'
    - 'Running'
    - 'Paused'
  - `createdAt` number, required
  - `definitionUpdatedAt` number, required

## Other responses

- `400` — Default Response

---

[API](https://skmtc.net/dittofeed/apis/dittofeed-api.md) · [All operations](https://skmtc.net/dittofeed/apis/dittofeed-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dittofeed/dittofeed-api/revisions/13cf71747bf1/schema)