Update Role
PATCHhttps://secure.fleetio.com/api/v1/roles/:id
Update a Role.
Request
Path Parameters
id stringrequired
Possible values: Value must match regular expression ^[0-9]+$
The id of the relevant record
- application/json
Body
namestring
The name for this Role.
defaultboolean
Whether this Role will be applied as the default Role for new Users.
Default value:
falsedescriptionstringnullable
A description of this Role.
contact_renewal_reminders_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonecontacts_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonedashboards_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonedocuments_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneequipments_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneexpense_entries_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonefaults_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonefuel_entries_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneinspections_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneintegrations_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneissues_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonelocation_entries_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonemeter_entries_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonemsi_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneparts_inventory_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneplaces_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonepurchase_orders_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonerecalls_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonereports_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneservice_entries_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneservice_programs_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneservice_reminders_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
noneservice_task_management_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonevehicle_renewal_reminders_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonevehicles_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonevendors_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonework_orders_accessRoleModuleAccessLevel (string)
Possible values: [full, some, none]
Default value:
nonevehicles_createboolean
vehicles_editboolean
vehicles_archive_deleteboolean
vehicles_update_statusboolean
vehicles_manage_vehicle_assignmentboolean
vehicles_view_detailsboolean
vehicles_view_financial_infoboolean
vehicles_view_custom_fieldsboolean
vehicles_view_documentsboolean
vehicles_manage_documentsboolean
vehicles_manage_photosboolean
vehicles_export_databoolean
equipments_createboolean
equipments_view_detailsboolean
equipments_view_financial_infoboolean
equipments_view_custom_fieldsboolean
equipments_export_databoolean
equipments_view_documentsboolean
equipments_manage_documentsboolean
equipments_manage_photosboolean
equipments_archive_deleteboolean
equipments_editboolean
equipments_update_statusboolean
equipments_manage_assignmentsboolean
meter_entries_createboolean
meter_entries_viewboolean
meter_entries_export_databoolean
meter_entries_editboolean
meter_entries_deleteboolean
fuel_entries_createboolean
fuel_entries_viewboolean
fuel_entries_export_databoolean
fuel_entries_editboolean
fuel_entries_deleteboolean
issues_createboolean
issues_view_openboolean
issues_view_resolved_or_closedboolean
issues_export_databoolean
issues_editboolean
issues_deleteboolean
issues_view_documentsboolean
issues_manage_documentsboolean
faults_viewboolean
faults_export_databoolean
faults_ignore_codesboolean
recalls_viewboolean
recalls_export_databoolean
recalls_ignoreboolean
service_tasks_createboolean
service_tasks_editboolean
service_tasks_archive_deleteboolean
service_entries_createboolean
service_entries_viewboolean
service_entries_view_update_cost_informationboolean
service_entries_export_databoolean
service_entries_editboolean
service_entries_deleteboolean
service_entries_view_documentsboolean
service_entries_manage_documentsboolean
work_orders_createboolean
work_orders_view_incompleteboolean
work_orders_view_completedboolean
work_orders_view_update_cost_informationboolean
work_orders_export_databoolean
work_orders_editboolean
work_orders_manage_labor_time_entriesboolean
work_orders_deleteboolean
work_orders_view_documentsboolean
work_orders_manage_documentsboolean
inspections_manage_inspection_formsboolean
inspections_manage_schedulesboolean
inspections_submit_inspectionsboolean
inspections_view_submissionsboolean
inspections_export_databoolean
inspections_edit_submissionsboolean
inspections_delete_submissionsboolean
msi_manage_payment_profileboolean
msi_manage_ro_notificationsboolean
msi_view_account_detailsboolean
msi_view_account_summaryboolean
msi_view_repair_order_notificationsboolean
msi_view_statementsboolean
msi_view_transactionsboolean
service_reminders_createboolean
service_reminders_viewboolean
service_reminders_export_databoolean
service_reminders_editboolean
service_reminders_deleteboolean
service_programs_create_updateboolean
service_programs_viewboolean
vehicle_renewal_reminders_createboolean
vehicle_renewal_reminders_viewboolean
vehicle_renewal_reminders_export_databoolean
vehicle_renewal_reminders_editboolean
vehicle_renewal_reminders_deleteboolean
contacts_createboolean
contacts_editboolean
contacts_view_basic_infoboolean
contacts_view_contact_and_personal_infoboolean
contacts_view_custom_fieldsboolean
contacts_export_databoolean
contacts_archive_deleteboolean
contacts_view_documentsboolean
contacts_manage_documentsboolean
contacts_manage_photosboolean
contact_renewal_reminders_createboolean
contact_renewal_reminders_viewboolean
contact_renewal_reminders_export_databoolean
contact_renewal_reminders_editboolean
contact_renewal_reminders_deleteboolean
vendors_createboolean
vendors_viewboolean
vendors_export_databoolean
vendors_editboolean
vendors_deleteboolean
vendors_view_documentsboolean
vendors_manage_documentsboolean
vendors_manage_photosboolean
parts_inventory_create_partsboolean
parts_inventory_edit_partsboolean
parts_inventory_update_inventory_quantitiesboolean
parts_inventory_view_part_detailsboolean
parts_inventory_view_part_activityboolean
parts_inventory_export_databoolean
parts_inventory_archive_delete_partsboolean
parts_inventory_view_documentsboolean
parts_inventory_manage_documentsboolean
purchase_orders_create_updateboolean
purchase_orders_deleteboolean
purchase_orders_viewboolean
purchase_orders_export_databoolean
purchase_orders_receiveboolean
purchase_orders_approveboolean
reports_vehiclesboolean
reports_contactsboolean
reports_partsboolean
reports_view_external_reportsboolean
reports_sharedboolean
places_createboolean
places_viewboolean
places_export_databoolean
places_editboolean
places_deleteboolean
location_entries_createboolean
location_entries_viewboolean
location_entries_editboolean
location_entries_deleteboolean
expense_entries_createboolean
expense_entries_viewboolean
expense_entries_export_databoolean
expense_entries_editboolean
expense_entries_deleteboolean
dashboards_manageboolean
dashboards_shareboolean
documents_view_global_documentsboolean
documents_manage_global_documentsboolean
gps_manage_devicesboolean
Responses
- 200
- 401
- 403
- 404
- 422
- 500
OK
- application/json
- Schema
- Example (auto)
Schema
idinteger
Possible values: >= 1
created_atdate-timerequired
The date and time at which this record was created.
Example:
2023-03-14T13:46:27-06:00updated_atdate-timerequired
The date and time at which this record was most recently updated.
Example:
2023-03-14T13:46:27-06:00namestringrequired
The name of this Role.
descriptionstringnullablerequired
The description of this Role.
defaultbooleanrequired
Whether this Role is applied as the default Role for new Users.
typestringrequired
Indicates whether this role is a standard Fleetio role, or created by a user.
Possible values: [StandardRole, CustomRole]
module_access objectrequired
module_permissions objectrequired
{
"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 (auto)
Schema
statusintegerrequired
Possible values: >= 400 and <= 599
titlestringrequired
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.
detailstring
A human-readable explanation specific to this occurrence of the problem.
instancestring
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 (auto)
Schema
statusintegerrequired
Possible values: >= 400 and <= 599
titlestringrequired
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.
detailstring
A human-readable explanation specific to this occurrence of the problem.
instancestring
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"
}
The requested resource could not be located
- application/json
- Schema
- Example (auto)
Schema
statusintegerrequired
Possible values: >= 400 and <= 599
titlestringrequired
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.
detailstring
A human-readable explanation specific to this occurrence of the problem.
instancestring
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 (auto)
- Example
Schema
errors object
{
"errors": {}
}
{
"errors": {
"field1": [
"error1",
"error2"
],
"field2": [
"error3"
]
}
}
Something unexpected happened
- application/json
- Schema
- Example (auto)
Schema
statusintegerrequired
Possible values: >= 400 and <= 599
titlestringrequired
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.
detailstring
A human-readable explanation specific to this occurrence of the problem.
instancestring
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"
}
Authorization: Authorization
name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64". You can generate a new API key [here](https://secure.fleetio.com/api_keys).
name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)
- curl
- ruby
- python
- csharp
- go
- java
- nodejs
- php
- CURL
curl -L -X PATCH 'https://secure.fleetio.com/api/v1/roles/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>' \
-d '{
"name": "string",
"default": false,
"description": "string",
"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",
"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
}'
ResponseClear
Click the Send API Request button above and see the response here!