Skip to main content
PATCH
/
api
/
v1
/
ops
/
trip-schedules
/
{tripScheduleId}
Update Trip Schedule
curl --request PATCH \
  --url https://api.example.com/api/v1/ops/trip-schedules/{tripScheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "São Paulo to Campinas daily morning"
}
'
{
  "tripScheduleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "vehicleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "driverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "interval": 123,
  "departureAt": "2023-11-07T05:31:56Z",
  "endAt": "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",
  "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

tripScheduleId
string<uuid>
required

Trip schedule 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 trip schedule payload

name
string
required

Trip schedule name

Example:

"São Paulo to Campinas daily morning"

Response

OK

Template recorrente que materializa viagens vendáveis em um horizonte móvel de 90 dias

tripScheduleId
string<uuid>
required

Identificador único

companyId
string<uuid>
required

Referência à empresa

routeId
string<uuid>
required

Referência à rota

vehicleId
string<uuid>
required

Referência ao veículo

driverId
string<uuid>
required

Referência ao motorista

name
string
required

Nome da programação

frequency
enum<string>
required

Frequência de geração

Available options:
DAILY,
WEEKLY,
MONTHLY
interval
integer
required

Intervalo entre ocorrências (default 1)

status
enum<string>
required

Estado de ativação (default ACTIVE)

Available options:
ACTIVE,
PAUSED,
ARCHIVED
departureAt
string<date-time>
required

Primeira partida programada

endAt
string<date-time> | null
required

Fim opcional da recorrência

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