Skip to main content

Add a Custom Field to Your Account

POST 
/settings/vehicles/custom-fields

Creates a new custom field for your account. Once created, every vehicle in your fleet can be given a value for it through /vehicles/{registration}/custom-fields — you only define it once here, not per vehicle.

Pick a type that actually matches what you're storing. fleet-api validates every value written against a field's type, so getting this right up front means bad data gets rejected immediately instead of causing problems downstream. Only set is_required to true if every vehicle must carry a value for this field going forward — it does not retroactively require existing vehicles to have one.

Your account can hold up to 10 custom fields at a time. Once you're at that limit this returns 422, and you'll need to delete a field you no longer use before adding another. Deleted fields don't count towards the limit.

Request​

Responses​

Successful operation