Account and settings

Update custom fields

Writes the values of an entity's custom fields.

Action
customFields.updateEntity
PropertyValue
DomaincustomFields
Group in the editorAccount and settings › Settings
Runs asThe owner of the workflow, with their permissions
PermissionAdministrators only
DestructiveNot declared

Inputs

entityTypeenum<string>Required

Available options: item, contact, space, project, kit, serializedItem, vehicle, staff, service, purchaseOrder, incident, repairTicket, opportunity

entityIdstringRequired

customFieldsobject[]Required

Array of custom fields to update.

Show child attributes
customFields.idstringRequired

customFields.namestring

customFields.valuejson

Value of the custom field.

customFields.dataTypeenum<string>

Available options: text, multitext, dropdown, checkbox, radio, date, contact, item, space, staffMember, vehicle

customFields.descriptionstring

customFields.metadatajson

Additional metadata of the custom field.

customFields.showOnstring[]

List of documents where the field is shown. It can be quote, proforma, invoice, packing_slip, all.

Available options: quote, proforma, invoice, contract, packing_slip, purchase_order, repair_ticket, all

customFields.applyAtstring[]

Platforms where the field applies. It can be order, item, space, contact, project, kit, template, all.

Available options: order, item, space, contact, project, kit, orderTemplate, repairTicket, document, serializedItem, vehicle, staff, service, purchaseOrder, incident, opportunity, all

customFields.optionsstring[]

Options for dropdown fields.

customFields.subscriptionIdstring

customFields.isActiveboolean

customFields.isArchivedboolean

customFields.ordernumber

customFields.createdAtstring

customFields.updatedAtstring

customFields.createdBystring

customFields.updatedBystring

customFields.archivedAtstring

customFields.archivedBystring

Outputs

successboolean

entityIdstring

updatedFieldsnumber