Skip to main content
POST
CREATE Custom Field

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

Body

application/json

Fields for creating a Building Custom Field on an Account.

fieldName
string
required

Name of the field. Must be unique among the Account's Custom Fields, ignoring case, and cannot be No Value.

Minimum string length: 1
fieldType
enum<string>
required

SINGLE fields hold free text per Building. MULTI fields hold one of a fixed list of options.

Available options:
SINGLE,
MULTI
active
boolean

Whether the field is shown on Buildings. Defaults to true.

options
string[]

The choices for a MULTI field; at least one is required, and values must be unique ignoring case. Not accepted for SINGLE fields, whose values are set through assignments.

Response

OK

An Account-level field your team tracks on Buildings beyond Prophia's standard set.

id
string
read-only

Prophia internal Custom Field ID (UUID).

accountId
string
read-only

The UUID for the Account this Custom Field belongs to.

fieldName
string

Name of the field.

fieldType
enum<string>
read-only

SINGLE fields hold free text per Building. MULTI fields hold one of a fixed list of options.

Available options:
SINGLE,
MULTI
active
boolean

Whether the field is shown on Buildings.

options
object[]
read-only

The field's current options.

createdBy
string
read-only

The user who created the field.

createdAt
string<date-time>
read-only

When the field was created.

updatedAt
string<date-time>
read-only

When the field was last modified.