Add a Driver Custom Field to Your Account

POST 
/settings/drivers/custom-fields

Creates a new driver custom field for your account. Once created, every driver in your fleet can be given a value for it through PUT /drivers/{driver_id}/custom-fields. You only define it once here, not per driver.

Pick a type that actually matches what you're storing. Every value written is validated against the field's type, so bad data gets rejected immediately. Only set is_required to true if every driver must carry a value for this field going forward. It does not retroactively require existing drivers to have one.

Your account can hold up to 10 driver custom fields at a time. Once you're at that limit this returns 422. Deleted fields don't count towards the limit.

Request

Responses

200

Successful operation

401

Unauthorized access. Authentication is required.

403

Access is forbidden. The user does not have permission to access this resource.

422

Validation failed for the input parameters.

500

Internal server error.