Skip to main content
PATCH
Update Role

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

roleId
string<uuid>
required

Role identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Update role payload

description
string | null

Role description

Example:

"Acesso total à organização"

name
string

Role name

Example:

"Administrador"

permissions
enum<string>[]

Granted permissions

Assignable permission identifier

Available options:
read:profile,
update:profile,
read:organization,
create:organization,
update:organization,
delete:organization,
read:role,
create:role,
update:role,
delete:role,
read:member,
create:member,
update:member,
delete:member,
read:employee,
create:employee,
update:employee,
read:cooperative,
read:user,
update:user,
read:benefit_category,
create:benefit_category,
update:benefit_category,
delete:benefit_category,
read:benefit_request,
update:benefit_request,
read:benefit_document,
update:benefit_document,
read:benefit_usage_history,
read:invite,
create:invite,
delete:invite,
read:audit,
read:support_case,
create:support_case,
update:support_case,
read:export,
create:export,
update:export,
read:notification,
update:notification,
delete:notification,
read:vehicle,
create:vehicle,
update:vehicle,
delete:vehicle,
read:seat-type,
read:driver,
create:driver,
update:driver,
delete:driver,
read:driver_transport_operator,
update:driver_transport_operator,
read:vehicle_transport_operator,
update:vehicle_transport_operator,
read:point,
create:point,
update:point,
delete:point,
read:transport_operator,
create:transport_operator,
update:transport_operator,
approve:transport_operator,
block:transport_operator,
reject:transport_operator,
unblock:transport_operator,
delete:transport_operator,
read:route,
create:route,
update:route,
delete:route,
read:route_approval,
update:route_approval,
approve:route_approval,
reject:route_approval,
read:transport_operator_route,
create:transport_operator_route,
update:transport_operator_route,
approve:transport_operator_route,
reject:transport_operator_route,
suspend:transport_operator_route,
reactivate:transport_operator_route,
read:transport_operator_route_policy,
create:transport_operator_route_policy,
update:transport_operator_route_policy,
delete:transport_operator_route_policy,
read:trip,
create:trip,
update:trip,
delete:trip,
read:trip_schedule,
create:trip_schedule,
update:trip_schedule,
delete:trip_schedule,
create:trip_event,
read:trip_review,
update:trip_review,
read:checkout,
read:order,
create:order,
update:order,
read:ticket,
create:ticket,
update:ticket,
delete:ticket,
read:payment,
read:cash_settlement,
update:cash_settlement,
read:cooperative_payment_settings,
update:cooperative_payment_settings,
read:transport_operator_subsidy_settlement,
update:transport_operator_subsidy_settlement,
approve:transport_operator_subsidy_settlement,
mark_paid:transport_operator_subsidy_settlement,
reject:transport_operator_subsidy_settlement,
read:balance,
read:receivable,
read:transfer,
create:transfer,
read:company_credit_account,
read:company_credit_purchase,
create:company_credit_purchase,
read:credit_grant,
create:credit_grant,
update:credit_grant,
read:webhook,
retry:webhook
Example:

Response

OK

Role

roleId
string<uuid>
required

Role identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

organizationId
string<uuid> | null
required

Organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

type
enum<string>
required

Role type

Available options:
INTERNAL,
ENVIRONMENT,
ORGANIZATION
Example:

"ORGANIZATION"

name
string
required

Role name

Example:

"Administrador"

permissions
enum<string>[]
required

Granted permissions

Assignable permission identifier

Available options:
read:profile,
update:profile,
read:organization,
create:organization,
update:organization,
delete:organization,
read:role,
create:role,
update:role,
delete:role,
read:member,
create:member,
update:member,
delete:member,
read:employee,
create:employee,
update:employee,
read:cooperative,
read:user,
update:user,
read:benefit_category,
create:benefit_category,
update:benefit_category,
delete:benefit_category,
read:benefit_request,
update:benefit_request,
read:benefit_document,
update:benefit_document,
read:benefit_usage_history,
read:invite,
create:invite,
delete:invite,
read:audit,
read:support_case,
create:support_case,
update:support_case,
read:export,
create:export,
update:export,
read:notification,
update:notification,
delete:notification,
read:vehicle,
create:vehicle,
update:vehicle,
delete:vehicle,
read:seat-type,
read:driver,
create:driver,
update:driver,
delete:driver,
read:driver_transport_operator,
update:driver_transport_operator,
read:vehicle_transport_operator,
update:vehicle_transport_operator,
read:point,
create:point,
update:point,
delete:point,
read:transport_operator,
create:transport_operator,
update:transport_operator,
approve:transport_operator,
block:transport_operator,
reject:transport_operator,
unblock:transport_operator,
delete:transport_operator,
read:route,
create:route,
update:route,
delete:route,
read:route_approval,
update:route_approval,
approve:route_approval,
reject:route_approval,
read:transport_operator_route,
create:transport_operator_route,
update:transport_operator_route,
approve:transport_operator_route,
reject:transport_operator_route,
suspend:transport_operator_route,
reactivate:transport_operator_route,
read:transport_operator_route_policy,
create:transport_operator_route_policy,
update:transport_operator_route_policy,
delete:transport_operator_route_policy,
read:trip,
create:trip,
update:trip,
delete:trip,
read:trip_schedule,
create:trip_schedule,
update:trip_schedule,
delete:trip_schedule,
create:trip_event,
read:trip_review,
update:trip_review,
read:checkout,
read:order,
create:order,
update:order,
read:ticket,
create:ticket,
update:ticket,
delete:ticket,
read:payment,
read:cash_settlement,
update:cash_settlement,
read:cooperative_payment_settings,
update:cooperative_payment_settings,
read:transport_operator_subsidy_settlement,
update:transport_operator_subsidy_settlement,
approve:transport_operator_subsidy_settlement,
mark_paid:transport_operator_subsidy_settlement,
reject:transport_operator_subsidy_settlement,
read:balance,
read:receivable,
read:transfer,
create:transfer,
read:company_credit_account,
read:company_credit_purchase,
create:company_credit_purchase,
read:credit_grant,
create:credit_grant,
update:credit_grant,
read:webhook,
retry:webhook
Example:
createdAt
string<date-time>
required

Created at

Example:

"2026-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required

Updated at

Example:

"2026-01-01T00:00:00.000Z"

description
string | null

Role description

Example:

"Acesso total à organização"

createdBy
string<uuid> | null

Creator user identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

updatedBy
string<uuid> | null

Updater user identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

deletedBy
string<uuid> | null

Remover user identifier

Example:

null

deletedAt
string<date-time> | null

Deleted at

Example:

null