Engine

Covers Engine 2.0.0

rapid/upsert-channel-field

Creates or updates a typed channel field.

  • Category: Channels and Persistence

Request payload

FieldTypeRequirementDescription
channel_namestringRequiredFlat RAPID channel name (channel or NODE:channel).
fieldstringOptionalChannel field to update; defaults to value.
valueany JSON valueRequiredTyped value for the field.
take_manual_controlbooleanOptionalAllow the operator write to establish manual override; defaults to false.
release_manual_overridebooleanOptionalRelease manual override; defaults to false.

Response payload

This operation returns an empty payload ({}).

Errors

  • The field is read-only, a required value is missing, an option value is invalid, or the channel name is invalid.