---
title: "Update a custom attribute"
method: PATCH
path: "/v3/custom-attributes/{id}"
tags: ["CustomAttributes"]
---

# Update a custom attribute

`PATCH /v3/custom-attributes/{id}`

## Request

- Base URL: `https://api.cryptlex.com`
- URL: `https://api.cryptlex.com/v3/custom-attributes/{id}`
- Auth: HTTP bearer

Updates the specified custom attribute by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

## Path parameters

- `id` string, uuid, required

## Request body

- CustomAttributeUpdateRequestModel
  - `displayName` string, nullable: Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.
  - `required` boolean, nullable
  - `defaultValue` string, nullable
  - `archived` boolean, nullable
  - `applicationAccess` 'none' | 'read' | 'read-write'
  - `userAccess` 'none' | 'read' | 'read-write'
  - `organizationAccess` 'none' | 'read' | 'read-write'
  - `resellerAccess` 'none' | 'read' | 'read-write'
  - `productIds` string[], nullable

## Response `200`

OK

- CustomAttributeDto
  - `id` string, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `name` string, required
  - `displayName` string, nullable
  - `resourceType` 'license' | 'product' | 'user' | 'organization' | 'reseller' | 'activation' | 'trial-activation', required
  - `dataType` 'string', required
  - `required` boolean, required
  - `defaultValue` string, nullable
  - `archived` boolean, required
  - `applicationAccess` 'none' | 'read' | 'read-write', required
  - `userAccess` 'none' | 'read' | 'read-write', required
  - `organizationAccess` 'none' | 'read' | 'read-write', required
  - `resellerAccess` 'none' | 'read' | 'read-write', required
  - `productIds` string[], nullable: Only set for License custom attributes — the products whose licenses the attribute applies to.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `429`: Too Many Requests
- `500`: Server Error

---

[API](https://skmtc.dev/cryptlex/apis/cryptlex-web-api.md) - [All operations](https://skmtc.dev/cryptlex/apis/cryptlex-web-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cryptlex/apis/cryptlex-web-api/revisions/0088bcd57a3c?raw)