Skip to main content
PATCH
UPDATE Custom Field Option

Authorizations

X-API-Key
string
header
required

Prophia API key — either an account key (grants admin level permissions) or a user key with the REST scope. Send it in the X-API-Key header, or equivalently as Authorization: Bearer <api-key>. JWTs are rejected on /rest endpoints with 401.

Path Parameters

accountId
string
required
fieldId
string
required
optionId
string
required

Body

application/json

An option on a MULTI Building Custom Field.

value
string
required

The option's value. Must be unique among the field's options, ignoring case.

Minimum string length: 1

Response

OK

A value of a Building Custom Field. On MULTI fields these are the fixed choices; on SINGLE fields they are the distinct values assigned to Buildings.

id
string
read-only

Prophia internal Custom Field Option ID (UUID).

value
string

The option's value.

createdAt
string<date-time>
read-only

When the option was created.

updatedAt
string<date-time>
read-only

When the option was last modified.