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
- 200
- 400
- 401
- 403
- 422
- 500
- 503
Successful operation
The request body is declared as JSON but cannot be parsed, or is not a JSON object or array. Nothing was processed.
Unauthorized access. Authentication is required.
Access is forbidden. The user does not have permission to access this resource, or the account is not currently active.
Validation failed for the input parameters.
Internal server error.
Service temporarily unavailable. The request did not complete and can be retried after the number of seconds in the Retry-After header, when one is sent.
Response Headers
Seconds to wait before retrying. Sent with db_busy and db_pool_timeout.