Skip to main content
PUT
Update canonical Attribute metadata

Usage notes

  • Omitted fields remain unchanged. type and the Relation kind are immutable.
  • Send expected_updated_at from your latest read to prevent overwriting a newer edit. A stale value returns 409 with code stale_write and current_updated_at.
  • A source-managed Attribute rejects source-owned changes unless you set detach: true in the same request.
  • Sending an empty image_config clears canonical image requirements. Sending number_config: null clears number presentation metadata.
The deprecated body field key does not rename the Attribute. Use the dedicated rename endpoint.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

key
string
required

Canonical Attribute key.

Body

application/json
key
string
deprecated

Retained for request compatibility but does not rename the Attribute. Use the rename operation.

label
string
format_output_type
enum<string> | null

Only valid for format Attributes. Omit to preserve the current output type; null resets it to text.

Available options:
text,
number,
boolean,
json,
richtext,
file,
image
enum_values
string[] | null
tags_values
string[] | null
allow_custom_values
boolean
boolean_config
object | null
number_config
object | null

Only valid for number or Formula-number Attributes. Send null to clear; omitted fields remain unchanged.

relation_config
object | null

Relation configuration may change, but relation kind is immutable.

description
string | null
validation
object | null
language
string | null

Omitted fields remain unchanged.

image_config
object

Omitted fields remain unchanged. Send an empty object to clear canonical requirements.

is_reviewed
boolean
detach
boolean

Detach a source-managed Attribute before editing source-owned content.

expected_updated_at
string<date-time>

Optional compare-and-set revision. Refetch after a stale_write response.

Response

Updated Attribute

id
string<uuid>
required
key
string
required
label
string
required
type
enum<string>
required
Available options:
text,
number,
url,
email,
date,
boolean,
richtext,
format,
enum,
tags,
image,
images,
file,
files,
json,
relation
format_output_type
enum<string> | null
required

The stored result type produced by a format Attribute. Format formulas execute only in Extraction; Catalog stores the resulting value.

Available options:
text,
number,
boolean,
json,
richtext,
file,
image
enum_values
string[] | null
required
tags_values
string[] | null
required
allow_custom_values
boolean
required

Whether table editors may append missing enum or tag choices.

boolean_config
object | null
required
number_config
object | null
required

Presentation metadata for number and Formula-number Attributes. Stored and API values remain numeric.

relation_config
object | null
required
description
string | null
required
validation
object | null
required
language
string | null
required
image_config
object | null
required

Canonical requirements shared by every usage of an image Attribute.

status
enum<string>
required

Derived from archive state. Archive and restore remain Dashboard-only.

Available options:
active,
archived
archived_at
string<date-time> | null
required
is_reviewed
boolean
required
source_id
string<uuid> | null
required
external_id
string | null
required
source_synced_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required