Skip to main content
POST
/
api
/
v1
/
ops
/
routes
/
{routeId}
/
deactivate
Deactivate Route
curl --request POST \
  --url https://api.example.com/api/v1/ops/routes/{routeId}/deactivate \
  --header 'Authorization: Bearer <token>'
{
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "originId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "destinationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "distanceKm": 123,
  "estimatedDuration": 123,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "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

​
routeId
string<uuid>
required

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

Response

OK

Rotas fixas operadas por empresas, referenciando Points do catálogo global como origem e destino

​
routeId
string<uuid>
required

Identificador único

​
companyId
string<uuid>
required

Referência à empresa

​
originId
string<uuid>
required

Referência ao Point de origem

​
destinationId
string<uuid>
required

Referência ao Point de destino

​
distanceKm
number
required

Distância em quilômetros

​
estimatedDuration
integer
required

Duração estimada em minutos

​
status
enum<string>
required

Status da rota

Available options:
PENDING_APPROVAL,
ACTIVE,
INACTIVE
​
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

​
deletedBy
string<uuid> | null
required

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

​
deletedAt
string<date-time> | null
required

Data de remoção