Skip to main content
POST
CREATE Custom Field Assignment

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

Body

application/json

Sets a Building Custom Field's value on one or more Buildings. Send value for a SINGLE field or optionId for a MULTI field — exactly one of the two. A Building that already has a value for the field is overwritten.

buildingIds
string[]
required

IDs of the Account's Buildings to set the value on; at most 200 per request.

Maximum array length: 200
optionId
string

For a MULTI field: the ID of one of the field's options.

value
string

For a SINGLE field: the free-text value. Reuses the field's existing value that matches ignoring case, if there is one.

Response

OK

id
string
read-only

Prophia internal Custom Field Assignment ID (UUID).

fieldId
string
read-only

The Custom Field the value is for.

buildingId
string
read-only

The Building the value is set on.

optionId
string
read-only

The option holding the value.

value
string
read-only

The Building's value for the field.

createdAt
string<date-time>
read-only

When the value was first set on the Building.

updatedAt
string<date-time>
read-only

When the value was last modified.