Update a Flexible Ride

patch

https://cabify-sandbox.com/api/v4/flexible_rides/{flexible_ride_id}

Updates a Flexible Ride.

Only a Flexible Ride that is on pending status can be updated.

⚠️
Claimable Since and Expiration
Take care that if the claimable_since field is updated, the expiration time on the Flexible Ride
will NOT be updated, unless the expires_in_seconds field is also passed in the update object.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

flexible_ride_id

string

required

UUID of the flexible ride

Body Params

Flexible Ride update request

Input object needed to update a Flexible Ride.

claimable_since

string | null

UTC ISO 8601 timestamp since when the flexible ride can be claimed.

expires_in_seconds

integer | null

Seconds until the Flexible Ride expires, counted from claimable_since, or from now if the Flexible Ride has none. Between 3600 (1 hour) and 259200 (3 days).

label_slug

string | null

Cost-center / project code.

max_price

object

Max price defined as budget ceiling on journey creation.

message

string | null

Driver-visible message to be set on create journey.

product_id

string

ID of the vehicle category/product used for this flexible ride, as returned by the estimates endpoint.

reason

string | null

Journey reason to be set once created.

rider

object

Input data defining the rider of a journey. If your platform books journeys on behalf of your own end customers (e.g. the customers of a marketplace or app built on top of Cabify) and those customers never need to log into Cabify's own apps, we recommend leaving id empty and providing name/mobile instead, rather than creating a User per customer. This avoids having to manage account activation for people who never interact with Cabify directly, and still lets the rider follow their journey and contact the driver through the journey's public_url.

rider_metadata

object | null

Client metadata.

sender_name

string | null

Name shown to the rider as the sender, in the message sent when the ride is created and on the claim page. Defaults to the client's name.

stops

array of objects

stops

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Callback

200Success

400Bad request

401Unauthorized

404Not found

500Internal server error