Set or replace a single field value on a collection

PUT

/collections/{id}/fields/{field_id}

• Local development behind nginx (port 8088 by default)

Authorizations

• cookieAuth
• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

field_id

required

string format: uuid

Request Body ^required

Pass whichever value_* field matches the target field’s type. Mismatches return 400 with value_type_mismatch.

object

value_text

string

nullable

value_num

number

nullable

value_date

string format: date-time

nullable

value_options

Array<string>

nullable

value_ref

string format: uuid

nullable

set_by

string

default: manual

Allowed values: manual api import computed

Responses

200

Value set

One field value as seen on a collection. Mirrors AssetFieldValue but for the collection subject_kind; the set_by vocabulary is narrower (no exif/iptc/xmp — collections aren’t files).

object

field_id

required

string format: uuid

field_code

required

string

field_label

string

type

required

string

Allowed values: text longtext rich_text number boolean date datetime select multi_select tree reference

value_text

string

nullable

value_num

number

nullable

value_date

string format: date-time

nullable

value_options

Array<string>

nullable

value_ref

string format: uuid

nullable

set_by

required

string

Allowed values: manual api import computed

set_at

required

string format: date-time

set_by_user_ref

integer format: int64

nullable

400

Malformed request

object

error

required

Human-readable error summary

string

Example

the request could not be completed

401

Authentication required, missing, or invalid

object

error

required

Human-readable error summary

string

Example

the request could not be completed

Example

{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

403

Authenticated but missing required capabilities

object

error

required

Human-readable error summary

string

Example

the request could not be completed

404

Resource not found

object

error

required

Human-readable error summary

string

Example

the request could not be completed

422

Field is asset-scoped (cannot be written on a collection) or value type doesn’t match the field’s declared type.

object

error

required

string

reason

required

string

Allowed values: field_not_for_collection value_type_mismatch

field

string

nullable