Inputs (UpdateCustomFieldDto[]) inherits from DtoBase
This method takes an array of UpdateCustomFieldDto. It consists of two properties that are vital for updating: BfsEntityBrickId (Guid) and CustomFields (array of CustomField). The BfsEntityBrickId targets the entity you want to update custom fields for, i.e an Account, Legal Entity etc. The CustomFields property is the one you populate the CustomFields to update. How does the system know what custom field to target/update? By looking at the FieldName property on each custom field. The FieldName property should match with the FieldName of the custom field in the database you would like to update.
Name | Type | Description | Mandatory | Available from version |
|---|---|---|---|---|
BfsEntityBrickId | Guid | The brick id of the entity. | Yes | 2.39 |
CustomFields | CustomField[] | The collection of custom fields you would like to update. | Yes | 2.39 |
Response UpdateCustomFieldResponse inherits from ResponseBase
Name | Type | Description | Available from version |
|---|---|---|---|
Entities | UpdateCustomFieldDto[] | And array of UpdateCustomFieldDto that was passed to the method. Now containing values for IsError and ErrorMessages depending on if everything worked normally or not. | 2.39 |
Message | string | A response message, "OK" if nothing went wrong and otherwise and error message. | 2.38 |
IsError | bool | A bool to describe if the entire request failed to perform any actions. If true then nothing was created, if false then all CustomFields that could be created were created. | 2.38 |