Skip to main content
PATCH
Update a field on a native format.

Authorizations

Authorization
string
header
required

Bearer authentication. Pass the access token in the Authorization: Bearer <token> header.

Path Parameters

fid
string<uuid>
required
vid
string<uuid>
required

Body

application/json
asset_binding
AssetBinding · object | null
constraints
TextConstraints · object
description
string | null
input_type
enum<string> | null
Available options:
text,
image,
video,
url,
number
is_required
boolean | null
label
string | null
Minimum string length: 1
name
string | null
Pattern: ^[a-z_]+$

Response

Successful Response

created_at
string<date-time>
required
id
string<uuid>
required

Unique identifier (UUID v7).

name
string
required

Human-readable name of the format.

owner_id
string<uuid>
required

ID of the operator who owns this format.

updated_at
string<date-time>
required
description
string | null

Optional description of the format.

fields
NativeFormatFieldResponse · object[]
format_type
enum<string>
default:user_defined

Whether this format is system-defined or user-defined.

Available options:
system_defined,
user_defined
no
integer | null
owner_name
string | null

Name of the format owner

status
enum<string>
default:inactive

Operational status of the format.

Available options:
active,
inactive