---
title: Update user property metadata
description: "Updates metadata on a user property. Returns 422 not in schema if the property is ingested-only. Same patch semantics as updating an event property (field ab…"
product: general
lang: en
last_updated: 2026-10-07
token_estimate: 1974
---
# Update user property metadata

> For AI agents: a documentation index is available at [/docs/llms.txt](/docs/llms.txt). Append `.md` to any page URL for markdown, or send `Accept: text/markdown`.

## Update user property metadata

**PATCH** `/v1/projects/{project_id}/user-properties/{user_property_id}`

Full URL: `https://developer-api.amplitude.com/v1/projects/{project_id}/user-properties/{user_property_id}`

**Servers:**
- Production (US): `https://developer-api.amplitude.com/v1/projects/{project_id}/user-properties/{user_property_id}`
- Production (EU): `https://developer-api.eu.amplitude.com/v1/projects/{project_id}/user-properties/{user_property_id}`

Update user property metadata

Updates metadata on a user property. Returns `422 not_in_schema` if the
property is ingested-only. Same patch semantics as updating an event property
(field absent = unchanged, `null` = clear, arrays replace).

Only `display_name`, `description`, `is_hidden`, and `classifications`
are mutable via PATCH today. Type/shape fields (`data_type`,
`is_array_type`, `enum_values`, `regex`) are settable only at creation.
`is_official` is read-only in this API version.

## Authorizations

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| Authorization | string | Yes | — | http |

## Path parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| project_id (path) | string | Yes | 12345 | Amplitude project identifier, backed by the canonical app ID. Constraints: pattern: ^[0-9]+$ |
| user_property_id (path) | string | Yes | — | Public user property identifier. Equal to `property_name`. URL-encode when the property name contains spaces or special characters. Constraints: min length: 1 |

## Header parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| Idempotency-Key (header) | string | Yes | — | Unique idempotency key used to safely retry write operations. Constraints: min length: 8, max length: 255 |

## Body (application/json)

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| display_name | string | No | — | Constraints: nullable |
| description | string | No | — | Constraints: nullable |
| is_hidden | boolean | No | — | — |
| classifications | string[] | No | — | — |

## Response (application/json)

**200** — User property updated.

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| data | object | Yes | — | — |
| data.id | string | Yes | — | Stable resource identifier. Equal to `property_name`. |
| data.object | string | Yes | — | Resource-type discriminator. Always `user_property`. |
| data.project_id | string | Yes | — | Constraints: pattern: ^[0-9]+$ |
| data.property_name | string | Yes | — | — |
| data.display_name | string | No | — | Constraints: nullable |
| data.description | string | No | — | Constraints: nullable |
| data.is_official | boolean | No | — | Curated/official flag. `null` ⇒ inherited / unset upstream. Constraints: nullable |
| data.is_hidden | boolean | Yes | — | — |
| data.is_in_schema | boolean | Yes | — | Whether this property is part of the project's curated tracking plan. Same semantics as `EventProperty.is_in_schema`. |
| data.data_type | string | No | — | Logical data type of a property. `null` means untyped at the source; clients should treat it as `string` for ingestion. Constraints: nullable Allowed values: string, number, boolean, object, enum, any, null |
| data.is_array_type | boolean | Yes | — | — |
| data.enum_values | string[] | Yes | — | — |
| data.regex | string | No | — | Constraints: nullable |
| data.classifications | string[] | Yes | — | — |

```json
{
  "data": {
    "id": "string",
    "object": "user_property",
    "project_id": "string",
    "property_name": "string",
    "display_name": "string",
    "description": "string",
    "is_official": true,
    "is_hidden": true,
    "is_in_schema": true,
    "data_type": "string",
    "is_array_type": true,
    "enum_values": [
      "string"
    ],
    "regex": "string",
    "classifications": [
      "string"
    ]
  }
}
```

**400**

**401**

**403**

**404**

**422** — Property is not part of the project's tracking plan. Returned when
attempting to PATCH a property with `is_in_schema: false`.


| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| type | string | Yes | — | Constraints: format: uri |
| title | string | Yes | — | — |
| status | integer | Yes | — | Constraints: min: 400, max: 599 |
| detail | string | No | — | Constraints: nullable |
| instance | string | No | — | Constraints: format: uri, nullable |
| error_code | string | Yes | — | — |
| retryable | boolean | Yes | — | — |
| retry_after_seconds | integer | No | — | Constraints: nullable, min: 0 |
| validation_errors | object[] | No | — | Constraints: nullable |

```json
{
  "type": "https://example.com",
  "title": "Property is not part of the project's tracking plan. Returned when\nattempting to PATCH a property with `is_in_schema: false`.\n",
  "status": 422,
  "detail": "string",
  "instance": "https://example.com",
  "error_code": "string",
  "retryable": true,
  "retry_after_seconds": 0,
  "validation_errors": [
    {
      "field": "string",
      "message": "string",
      "code": "string"
    }
  ]
}
```

**429**

**500**

## Code samples

### cURL

```bash
curl -X PATCH "https://developer-api.amplitude.com/v1/projects/12345/user-properties/{user_property_id}" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.patch(
    "https://developer-api.amplitude.com/v1/projects/12345/user-properties/{user_property_id}",
    headers={
        "Content-Type": "application/json",
        "Authorization": "YOUR_API_KEY"
    }
)
data = response.json()
```

### JavaScript

```javascript
const response = await fetch("https://developer-api.amplitude.com/v1/projects/12345/user-properties/{user_property_id}", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_KEY"
  }
});
const data = await response.json();
```

### PHP

```php
<?php
$ch = curl_init("https://developer-api.amplitude.com/v1/projects/12345/user-properties/{user_property_id}");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: YOUR_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
```

### Go

```go
package main

import (
  "bytes"
  "net/http"
)

func main() {
req, _ := http.NewRequest("PATCH", "https://developer-api.amplitude.com/v1/projects/12345/user-properties/{user_property_id}", nil)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "YOUR_API_KEY")
  client := &http.Client{}
  resp, _ := client.Do(req)
  defer resp.Body.Close()
}
```

### Java

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://developer-api.amplitude.com/v1/projects/12345/user-properties/{user_property_id}"))
      .method("PATCH", HttpRequest.BodyPublishers.noBody())
.header("Content-Type", "application/json")
      .header("Authorization", "YOUR_API_KEY")
      .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://developer-api.amplitude.com/v1/projects/12345/user-properties/{user_property_id}")
request = Net::HTTP::Patch.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
```