Public API Reference (Beta)Custom FieldsCore

Set a custom field's value for an entity

Sets (or overwrites) this field's value for the entity. body.fieldTypeId must match the field's actual data type as returned by GET .../definitions — this guards against sending a text value to a numeric field, for example. For SELECT fields, body.optionGk selects one of the field's valid options (also from GET .../definitions); for DATE/TIME fields, body.value must be an ISO-8601 timestamp. Only entity types with a registered write handler support this endpoint today (Requirement/Job).

Authentication

X-Brightmove-Company-ApiKeystring
BrightMove Company Api Key
X-Brightmove-User-ApiKeystring
BrightMove User Api Key

Path parameters

entityTypeIdintegerRequired

Numeric entity type id (e.g. 5 = Requirement/Job)

guidstringRequired
GUID of the entity to set the value on
fieldGklongRequired

Numeric id of the field definition, from GET …/definitions

Request

This endpoint expects an object.
fieldTypeIdintegerRequired

Data type of the field being set. Must match the field’s actual definition. 1=Text, 2=Text Area, 3=Checkbox, 4=Select (dropdown), 5=Number, 6=Currency, 7=Date, 10=Time.

valuestringOptional

New value for this field, as a string. Dates/times must be ISO-8601. Not used for Select-type fields — use optionGk instead.

optionGklongOptional

Identifier of the option to select, for Select-type fields only.

Response

Value set

Errors

404
Not Found Error