Create Role

Creates a new Role

application/json

Request Body

name string required
The name for this Role.
default boolean
Default value: false
Whether this Role will be applied as the default Role for new Users.
description string
A description of this Role.
contact_renewal_reminders_access string
Possible values: [full, some, none]
Default value: none
contacts_access string
Possible values: [full, some, none]
Default value: none
dashboards_access string
Possible values: [full, some, none]
Default value: none
documents_access string
Possible values: [full, some, none]
Default value: none
equipments_access string
Possible values: [full, some, none]
Default value: none
expense_entries_access string
Possible values: [full, some, none]
Default value: none
faults_access string
Possible values: [full, some, none]
Default value: none
fuel_entries_access string
Possible values: [full, some, none]
Default value: none
inspections_access string
Possible values: [full, some, none]
Default value: none
integrations_access string
Possible values: [full, some, none]
Default value: none
issues_access string
Possible values: [full, some, none]
Default value: none
location_entries_access string
Possible values: [full, some, none]
Default value: none
meter_entries_access string
Possible values: [full, some, none]
Default value: none
msi_access string
Possible values: [full, some, none]
Default value: none
parts_inventory_access string
Possible values: [full, some, none]
Default value: none
places_access string
Possible values: [full, some, none]
Default value: none
purchase_orders_access string
Possible values: [full, some, none]
Default value: none
recalls_access string
Possible values: [full, some, none]
Default value: none
reports_access string
Possible values: [full, some, none]
Default value: none
service_entries_access string
Possible values: [full, some, none]
Default value: none
service_programs_access string
Possible values: [full, some, none]
Default value: none
service_reminders_access string
Possible values: [full, some, none]
Default value: none
service_task_management_access string
Possible values: [full, some, none]
Default value: none
vehicle_renewal_reminders_access string
Possible values: [full, some, none]
Default value: none
vehicles_access string
Possible values: [full, some, none]
Default value: none
vendors_access string
Possible values: [full, some, none]
Default value: none
work_orders_access string
Possible values: [full, some, none]
Default value: none
vehicles_create boolean
vehicles_edit boolean
vehicles_archive_delete boolean
vehicles_update_status boolean
vehicles_manage_vehicle_assignment boolean
vehicles_view_details boolean
vehicles_view_financial_info boolean
vehicles_view_custom_fields boolean
vehicles_view_documents boolean
vehicles_manage_documents boolean
vehicles_manage_photos boolean
vehicles_export_data boolean
equipments_create boolean
equipments_view_details boolean
equipments_view_financial_info boolean
equipments_view_custom_fields boolean
equipments_export_data boolean
equipments_view_documents boolean
equipments_manage_documents boolean
equipments_manage_photos boolean
equipments_archive_delete boolean
equipments_edit boolean
equipments_update_status boolean
equipments_manage_assignments boolean
meter_entries_create boolean
meter_entries_view boolean
meter_entries_export_data boolean
meter_entries_edit boolean
meter_entries_delete boolean
fuel_entries_create boolean
fuel_entries_view boolean
fuel_entries_export_data boolean
fuel_entries_edit boolean
fuel_entries_delete boolean
issues_create boolean
issues_view_open boolean
issues_view_resolved_or_closed boolean
issues_export_data boolean
issues_edit boolean
issues_delete boolean
issues_view_documents boolean
issues_manage_documents boolean
faults_view boolean
faults_export_data boolean
faults_ignore_codes boolean
recalls_view boolean
recalls_export_data boolean
recalls_ignore boolean
service_tasks_create boolean
service_tasks_edit boolean
service_tasks_archive_delete boolean
service_entries_create boolean
service_entries_view boolean
service_entries_view_update_cost_information boolean
service_entries_export_data boolean
service_entries_edit boolean
service_entries_delete boolean
service_entries_view_documents boolean
service_entries_manage_documents boolean
work_orders_create boolean
work_orders_view_incomplete boolean
work_orders_view_completed boolean
work_orders_view_update_cost_information boolean
work_orders_export_data boolean
work_orders_edit boolean
work_orders_manage_labor_time_entries boolean
work_orders_delete boolean
work_orders_view_documents boolean
work_orders_manage_documents boolean
inspections_manage_inspection_forms boolean
inspections_manage_schedules boolean
inspections_submit_inspections boolean
inspections_view_submissions boolean
inspections_export_data boolean
inspections_edit_submissions boolean
inspections_delete_submissions boolean
msi_manage_payment_profile boolean
msi_manage_ro_notifications boolean
msi_view_account_details boolean
msi_view_account_summary boolean
msi_view_repair_order_notifications boolean
msi_view_statements boolean
msi_view_transactions boolean
service_reminders_create boolean
service_reminders_view boolean
service_reminders_export_data boolean
service_reminders_edit boolean
service_reminders_delete boolean
service_programs_create_update boolean
service_programs_view boolean
vehicle_renewal_reminders_create boolean
vehicle_renewal_reminders_view boolean
vehicle_renewal_reminders_export_data boolean
vehicle_renewal_reminders_edit boolean
vehicle_renewal_reminders_delete boolean
contacts_create boolean
contacts_edit boolean
contacts_view_basic_info boolean
contacts_view_contact_and_personal_info boolean
contacts_view_custom_fields boolean
contacts_export_data boolean
contacts_archive_delete boolean
contacts_view_documents boolean
contacts_manage_documents boolean
contacts_manage_photos boolean
contact_renewal_reminders_create boolean
contact_renewal_reminders_view boolean
contact_renewal_reminders_export_data boolean
contact_renewal_reminders_edit boolean
contact_renewal_reminders_delete boolean
vendors_create boolean
vendors_view boolean
vendors_export_data boolean
vendors_edit boolean
vendors_delete boolean
vendors_view_documents boolean
vendors_manage_documents boolean
vendors_manage_photos boolean
parts_inventory_create_parts boolean
parts_inventory_edit_parts boolean
parts_inventory_update_inventory_quantities boolean
parts_inventory_view_part_details boolean
parts_inventory_view_part_activity boolean
parts_inventory_export_data boolean
parts_inventory_archive_delete_parts boolean
parts_inventory_view_documents boolean
parts_inventory_manage_documents boolean
purchase_orders_create_update boolean
purchase_orders_delete boolean
purchase_orders_view boolean
purchase_orders_export_data boolean
purchase_orders_receive boolean
purchase_orders_approve boolean
reports_vehicles boolean
reports_contacts boolean
reports_parts boolean
reports_view_external_reports boolean
reports_shared boolean
places_create boolean
places_view boolean
places_export_data boolean
places_edit boolean
places_delete boolean
location_entries_create boolean
location_entries_view boolean
location_entries_edit boolean
location_entries_delete boolean
expense_entries_create boolean
expense_entries_view boolean
expense_entries_export_data boolean
expense_entries_edit boolean
expense_entries_delete boolean
dashboards_manage boolean
dashboards_share boolean
documents_view_global_documents boolean
documents_manage_global_documents boolean
gps_manage_devices boolean

Responses

Response Headers

application/json

Schema
Example (from schema)

Schema

id integer
Possible values: >= 1
created_at date-time
The date and time at which this record was created.
updated_at date-time
The date and time at which this record was most recently updated.
name string
The name of this Role.
description string
The description of this Role.
default boolean
Whether this Role is applied as the default Role for new Users.
type string
Possible values: [StandardRole, CustomRole]
Indicates whether this role is a standard Fleetio role, or created by a user.
module_access object
contact_renewal_reminders_access string
Possible values: [full, some, none]
Default value: none
contacts_access string
Possible values: [full, some, none]
Default value: none
dashboards_access string
Possible values: [full, some, none]
Default value: none
documents_access string
Possible values: [full, some, none]
Default value: none
equipments_access string
Possible values: [full, some, none]
Default value: none
expense_entries_access string
Possible values: [full, some, none]
Default value: none
faults_access string
Possible values: [full, some, none]
Default value: none
fuel_entries_access string
Possible values: [full, some, none]
Default value: none
inspections_access string
Possible values: [full, some, none]
Default value: none
integrations_access string
Possible values: [full, some, none]
Default value: none
issues_access string
Possible values: [full, some, none]
Default value: none
location_entries_access string
Possible values: [full, some, none]
Default value: none
meter_entries_access string
Possible values: [full, some, none]
Default value: none
msi_access string
Possible values: [full, some, none]
Default value: none
parts_inventory_access string
Possible values: [full, some, none]
Default value: none
places_access string
Possible values: [full, some, none]
Default value: none
purchase_orders_access string
Possible values: [full, some, none]
Default value: none
recalls_access string
Possible values: [full, some, none]
Default value: none
reports_access string
Possible values: [full, some, none]
Default value: none
service_entries_access string
Possible values: [full, some, none]
Default value: none
service_programs_access string
Possible values: [full, some, none]
Default value: none
service_reminders_access string
Possible values: [full, some, none]
Default value: none
service_task_management_access string
Possible values: [full, some, none]
Default value: none
vehicle_renewal_reminders_access string
Possible values: [full, some, none]
Default value: none
vehicles_access string
Possible values: [full, some, none]
Default value: none
vendors_access string
Possible values: [full, some, none]
Default value: none
work_orders_access string
Possible values: [full, some, none]
Default value: none
module_permissions object
vehicles_create boolean
vehicles_edit boolean
vehicles_archive_delete boolean
vehicles_update_status boolean
vehicles_manage_vehicle_assignment boolean
vehicles_view_details boolean
vehicles_view_financial_info boolean
vehicles_view_custom_fields boolean
vehicles_view_documents boolean
vehicles_manage_documents boolean
vehicles_manage_photos boolean
vehicles_export_data boolean
equipments_create boolean
equipments_view_details boolean
equipments_view_financial_info boolean
equipments_view_custom_fields boolean
equipments_export_data boolean
equipments_view_documents boolean
equipments_manage_documents boolean
equipments_manage_photos boolean
equipments_archive_delete boolean
equipments_edit boolean
equipments_update_status boolean
equipments_manage_assignments boolean
meter_entries_create boolean
meter_entries_view boolean
meter_entries_export_data boolean
meter_entries_edit boolean
meter_entries_delete boolean
fuel_entries_create boolean
fuel_entries_view boolean
fuel_entries_export_data boolean
fuel_entries_edit boolean
fuel_entries_delete boolean
issues_create boolean
issues_view_open boolean
issues_view_resolved_or_closed boolean
issues_export_data boolean
issues_edit boolean
issues_delete boolean
issues_view_documents boolean
issues_manage_documents boolean
faults_view boolean
faults_export_data boolean
faults_ignore_codes boolean
recalls_view boolean
recalls_export_data boolean
recalls_ignore boolean
service_tasks_create boolean
service_tasks_edit boolean
service_tasks_archive_delete boolean
service_entries_create boolean
service_entries_view boolean
service_entries_view_update_cost_information boolean
service_entries_export_data boolean
service_entries_edit boolean
service_entries_delete boolean
service_entries_view_documents boolean
service_entries_manage_documents boolean
work_orders_create boolean
work_orders_view_incomplete boolean
work_orders_view_completed boolean
work_orders_view_update_cost_information boolean
work_orders_export_data boolean
work_orders_edit boolean
work_orders_manage_labor_time_entries boolean
work_orders_delete boolean
work_orders_view_documents boolean
work_orders_manage_documents boolean
inspections_manage_inspection_forms boolean
inspections_manage_schedules boolean
inspections_submit_inspections boolean
inspections_view_submissions boolean
inspections_export_data boolean
inspections_edit_submissions boolean
inspections_delete_submissions boolean
msi_manage_payment_profile boolean
msi_manage_ro_notifications boolean
msi_view_account_details boolean
msi_view_account_summary boolean
msi_view_repair_order_notifications boolean
msi_view_statements boolean
msi_view_transactions boolean
service_reminders_create boolean
service_reminders_view boolean
service_reminders_export_data boolean
service_reminders_edit boolean
service_reminders_delete boolean
service_programs_create_update boolean
service_programs_view boolean
vehicle_renewal_reminders_create boolean
vehicle_renewal_reminders_view boolean
vehicle_renewal_reminders_export_data boolean
vehicle_renewal_reminders_edit boolean
vehicle_renewal_reminders_delete boolean
contacts_create boolean
contacts_edit boolean
contacts_view_basic_info boolean
contacts_view_contact_and_personal_info boolean
contacts_view_custom_fields boolean
contacts_export_data boolean
contacts_archive_delete boolean
contacts_view_documents boolean
contacts_manage_documents boolean
contacts_manage_photos boolean
contact_renewal_reminders_create boolean
contact_renewal_reminders_view boolean
contact_renewal_reminders_export_data boolean
contact_renewal_reminders_edit boolean
contact_renewal_reminders_delete boolean
vendors_create boolean
vendors_view boolean
vendors_export_data boolean
vendors_edit boolean
vendors_delete boolean
vendors_view_documents boolean
vendors_manage_documents boolean
vendors_manage_photos boolean
parts_inventory_create_parts boolean
parts_inventory_edit_parts boolean
parts_inventory_update_inventory_quantities boolean
parts_inventory_view_part_details boolean
parts_inventory_view_part_activity boolean
parts_inventory_export_data boolean
parts_inventory_archive_delete_parts boolean
parts_inventory_view_documents boolean
parts_inventory_manage_documents boolean
purchase_orders_create_update boolean
purchase_orders_delete boolean
purchase_orders_view boolean
purchase_orders_export_data boolean
purchase_orders_receive boolean
purchase_orders_approve boolean
reports_vehicles boolean
reports_contacts boolean
reports_parts boolean
reports_view_external_reports boolean
reports_shared boolean
places_create boolean
places_view boolean
places_export_data boolean
places_edit boolean
places_delete boolean
location_entries_create boolean
location_entries_view boolean
location_entries_edit boolean
location_entries_delete boolean
expense_entries_create boolean
expense_entries_view boolean
expense_entries_export_data boolean
expense_entries_edit boolean
expense_entries_delete boolean
dashboards_manage boolean
dashboards_share boolean
documents_view_global_documents boolean
documents_manage_global_documents boolean
gps_manage_devices boolean

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "name": "string",
  "description": "string",
  "default": true,
  "type": "StandardRole",
  "module_access": {
    "contact_renewal_reminders_access": "none",
    "contacts_access": "none",
    "dashboards_access": "none",
    "documents_access": "none",
    "equipments_access": "none",
    "expense_entries_access": "none",
    "faults_access": "none",
    "fuel_entries_access": "none",
    "inspections_access": "none",
    "integrations_access": "none",
    "issues_access": "none",
    "location_entries_access": "none",
    "meter_entries_access": "none",
    "msi_access": "none",
    "parts_inventory_access": "none",
    "places_access": "none",
    "purchase_orders_access": "none",
    "recalls_access": "none",
    "reports_access": "none",
    "service_entries_access": "none",
    "service_programs_access": "none",
    "service_reminders_access": "none",
    "service_task_management_access": "none",
    "vehicle_renewal_reminders_access": "none",
    "vehicles_access": "none",
    "vendors_access": "none",
    "work_orders_access": "none"
  },
  "module_permissions": {
    "vehicles_create": true,
    "vehicles_edit": true,
    "vehicles_archive_delete": true,
    "vehicles_update_status": true,
    "vehicles_manage_vehicle_assignment": true,
    "vehicles_view_details": true,
    "vehicles_view_financial_info": true,
    "vehicles_view_custom_fields": true,
    "vehicles_view_documents": true,
    "vehicles_manage_documents": true,
    "vehicles_manage_photos": true,
    "vehicles_export_data": true,
    "equipments_create": true,
    "equipments_view_details": true,
    "equipments_view_financial_info": true,
    "equipments_view_custom_fields": true,
    "equipments_export_data": true,
    "equipments_view_documents": true,
    "equipments_manage_documents": true,
    "equipments_manage_photos": true,
    "equipments_archive_delete": true,
    "equipments_edit": true,
    "equipments_update_status": true,
    "equipments_manage_assignments": true,
    "meter_entries_create": true,
    "meter_entries_view": true,
    "meter_entries_export_data": true,
    "meter_entries_edit": true,
    "meter_entries_delete": true,
    "fuel_entries_create": true,
    "fuel_entries_view": true,
    "fuel_entries_export_data": true,
    "fuel_entries_edit": true,
    "fuel_entries_delete": true,
    "issues_create": true,
    "issues_view_open": true,
    "issues_view_resolved_or_closed": true,
    "issues_export_data": true,
    "issues_edit": true,
    "issues_delete": true,
    "issues_view_documents": true,
    "issues_manage_documents": true,
    "faults_view": true,
    "faults_export_data": true,
    "faults_ignore_codes": true,
    "recalls_view": true,
    "recalls_export_data": true,
    "recalls_ignore": true,
    "service_tasks_create": true,
    "service_tasks_edit": true,
    "service_tasks_archive_delete": true,
    "service_entries_create": true,
    "service_entries_view": true,
    "service_entries_view_update_cost_information": true,
    "service_entries_export_data": true,
    "service_entries_edit": true,
    "service_entries_delete": true,
    "service_entries_view_documents": true,
    "service_entries_manage_documents": true,
    "work_orders_create": true,
    "work_orders_view_incomplete": true,
    "work_orders_view_completed": true,
    "work_orders_view_update_cost_information": true,
    "work_orders_export_data": true,
    "work_orders_edit": true,
    "work_orders_manage_labor_time_entries": true,
    "work_orders_delete": true,
    "work_orders_view_documents": true,
    "work_orders_manage_documents": true,
    "inspections_manage_inspection_forms": true,
    "inspections_manage_schedules": true,
    "inspections_submit_inspections": true,
    "inspections_view_submissions": true,
    "inspections_export_data": true,
    "inspections_edit_submissions": true,
    "inspections_delete_submissions": true,
    "msi_manage_payment_profile": true,
    "msi_manage_ro_notifications": true,
    "msi_view_account_details": true,
    "msi_view_account_summary": true,
    "msi_view_repair_order_notifications": true,
    "msi_view_statements": true,
    "msi_view_transactions": true,
    "service_reminders_create": true,
    "service_reminders_view": true,
    "service_reminders_export_data": true,
    "service_reminders_edit": true,
    "service_reminders_delete": true,
    "service_programs_create_update": true,
    "service_programs_view": true,
    "vehicle_renewal_reminders_create": true,
    "vehicle_renewal_reminders_view": true,
    "vehicle_renewal_reminders_export_data": true,
    "vehicle_renewal_reminders_edit": true,
    "vehicle_renewal_reminders_delete": true,
    "contacts_create": true,
    "contacts_edit": true,
    "contacts_view_basic_info": true,
    "contacts_view_contact_and_personal_info": true,
    "contacts_view_custom_fields": true,
    "contacts_export_data": true,
    "contacts_archive_delete": true,
    "contacts_view_documents": true,
    "contacts_manage_documents": true,
    "contacts_manage_photos": true,
    "contact_renewal_reminders_create": true,
    "contact_renewal_reminders_view": true,
    "contact_renewal_reminders_export_data": true,
    "contact_renewal_reminders_edit": true,
    "contact_renewal_reminders_delete": true,
    "vendors_create": true,
    "vendors_view": true,
    "vendors_export_data": true,
    "vendors_edit": true,
    "vendors_delete": true,
    "vendors_view_documents": true,
    "vendors_manage_documents": true,
    "vendors_manage_photos": true,
    "parts_inventory_create_parts": true,
    "parts_inventory_edit_parts": true,
    "parts_inventory_update_inventory_quantities": true,
    "parts_inventory_view_part_details": true,
    "parts_inventory_view_part_activity": true,
    "parts_inventory_export_data": true,
    "parts_inventory_archive_delete_parts": true,
    "parts_inventory_view_documents": true,
    "parts_inventory_manage_documents": true,
    "purchase_orders_create_update": true,
    "purchase_orders_delete": true,
    "purchase_orders_view": true,
    "purchase_orders_export_data": true,
    "purchase_orders_receive": true,
    "purchase_orders_approve": true,
    "reports_vehicles": true,
    "reports_contacts": true,
    "reports_parts": true,
    "reports_view_external_reports": true,
    "reports_shared": true,
    "places_create": true,
    "places_view": true,
    "places_export_data": true,
    "places_edit": true,
    "places_delete": true,
    "location_entries_create": true,
    "location_entries_view": true,
    "location_entries_edit": true,
    "location_entries_delete": true,
    "expense_entries_create": true,
    "expense_entries_view": true,
    "expense_entries_export_data": true,
    "expense_entries_edit": true,
    "expense_entries_delete": true,
    "dashboards_manage": true,
    "dashboards_share": true,
    "documents_view_global_documents": true,
    "documents_manage_global_documents": true,
    "gps_manage_devices": true
  }
}

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Insufficient permission to perform this operation

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Unprocessable Entity

application/json

Schema
Example (from schema)
Example

Schema

errors object
type
items string

{
  "errors": {}
}

{
  "errors": {
    "field1": [
      "error1",
      "error2"
    ],
    "field2": [
      "error3"
    ]
  }
}

Something unexpected happened

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 599
title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
detail string
A human-readable explanation specific to this occurrence of the problem.
instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}