DeleteCustomFields

Inputs (DeleteCustomFieldDto[]) inherits from DtoBase

In this method two arguments must be passed. Firstly, the brick id of the entity on which the custom field exists and secondly the brick id of the custom field to delete. For example, if you wish to delete a certain custom field on an account you need to pass the brick id of the account as well as the brick id of the custom field to delete on that account.

Name

Type

Description

Mandatory

Available from version

Name

Type

Description

Mandatory

Available from version

BfsEntityBrickId

Guid

The brick id of the entity on which the custom field exists.

Yes

2.38

CustomFieldBrickId

Guid

The brick id of the custom field to delete.

Yes

2.38

 

Response DeleteCustomFieldResponse inherits from ResponseBase

Name

Type

Description

Available from version

Name

Type

Description

Available from version

Entities

DeleteCustomFieldDto[]

And array of DeleteCustomFieldDto that was passed to the method. Now containing values for IsError and ErrorMessages depending on if everything worked normally or not.

2.38

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 deleted, if false then all CustomFields that could be deleted were deleted.

2.38