Asset Custom Field

Update Asset Custom Field

Renames an existing asset custom field definition. Only the name can be changed — the field type is immutable after creation. All existing values stored on assets for this field remain intact.

PATCH

https://api.employmenthero.com/api/v1/organisations/:organisation_id/asset_custom_fields/:id

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

iduuidrequired

The ID of the custom field to update.

Request Body

namestringrequired

New unique name for the custom field. Must be unique within the organisation (case-insensitive). Maximum 255 characters.

Response Body

The updated asset custom field with its new name.

dataobject

iduuid

Unique identifier of the asset custom field.

namestring

Display name of the custom field. Unique within the organisation (case-insensitive).

field_typeenum<string>

The data type of the custom field. Immutable after creation.

Example

curl -X PATCH \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/asset_custom_fields/:id" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \  -H "Content-Type: application/json" \  -d '{    "name": "Warranty ID"  }'

Response

{  "data": {    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",    "name": "Warranty ID",    "field_type": "text"  }}

Delete Asset Custom Field

Permanently deletes a custom field definition and all values stored for that field across every asset in the organisation. This action cannot be undone.

DELETE