Skip to main content
POST
/
api
/
v1
/
ops
/
route-approvals
/
{routeApprovalId}
/
reject
Reject Route Approval
curl --request POST \
  --url https://api.example.com/api/v1/ops/route-approvals/{routeApprovalId}/reject \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rejectionReason": "Origin and destination need review."
}
'
{
  "routeApprovalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requestedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reviewedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rejectionReason": "<string>",
  "requestedAt": "2023-11-07T05:31:56Z",
  "reviewedAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

routeApprovalId
string<uuid>
required

Route approval 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

Reject route approval payload

rejectionReason
string
required

Reason why the route was rejected

Minimum string length: 1
Example:

"Origin and destination need review."

Response

OK

Histórico de aprovação ou reprovação de uma rota

routeApprovalId
string<uuid>
required

Identificador único

routeId
string<uuid>
required

Rota analisada

requestedBy
string<uuid>
required

Usuário que solicitou ou criou a rota para análise

reviewedBy
string<uuid> | null
required

Usuário que aprovou ou rejeitou a rota

status
enum<string>
required

Status da análise

Available options:
PENDING,
APPROVED,
REJECTED
rejectionReason
string | null
required

Motivo da rejeição, quando aplicável

requestedAt
string<date-time>
required

Data de solicitação de análise

reviewedAt
string<date-time> | null
required

Data da aprovação ou rejeição

createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

createdAt
string<date-time>
required

Data de criação

updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

updatedAt
string<date-time>
required

Data da última atualização