Update Role

Update a Role.

Path Parameters

id string required
Possible values: Value must match regular expression ^[0-9]+$
The id of the relevant record

application/json

Request Body

name string
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_view_account_details boolean
msi_view_account_summary 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

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"
}

The requested resource could not be located

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"
}