Skip to main content
PATCH
Update Trip Schedule

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

Trip schedule

tripScheduleId
string<uuid>
required

Trip schedule identifier

Example:

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

cooperativeId
string<uuid>
required

Cooperative identifier

Example:

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

transportOperatorId
string<uuid>
required

Transport operator identifier

Example:

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

routeId
string<uuid>
required

Route identifier

Example:

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

vehicleId
string<uuid>
required

Vehicle identifier

Example:

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

driverId
string<uuid>
required

Driver identifier

Example:

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

name
string
required

Trip schedule name

Example:

"São Paulo to Campinas daily morning"

frequency
enum<string>
required

Trip schedule frequency

Available options:
DAILY,
WEEKLY,
MONTHLY
Example:

"DAILY"

interval
integer
required

Frequency interval

Example:

1

status
enum<string>
required

Trip schedule status

Available options:
ACTIVE,
PAUSED,
ARCHIVED
Example:

"ACTIVE"

departureAt
string<date-time>
required

First scheduled departure

Example:

"2026-04-15T08:00:00.000Z"

stops
object[]
required

Trip schedule stops

itineraries
object[]
required

Trip schedule itineraries

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"

createdBy
string<uuid> | null

Created by

Example:

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

updatedBy
string<uuid> | null

Updated by

Example:

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

deletedBy
string<uuid> | null

Deleted by

Example:

null

endAt
string<date-time> | null

Optional recurrence end

Example:

"2026-12-31T23:59:59.000Z"