Requesting a Trip
Requesting a trip is closely linked to the Estimates section. Whether within the same UI or a new screen, the User should be able to select the trip based on the /estimates
response.
¶ Required Information
- Customer Name: Use
guest.first_name
andguest.last_name
. - Phone Number: Use
guest.phone_number
. This is required for communication through SMS. - Pickup and Dropoff: Latitude and longitude are required for both locations. Optional but recommended fields include full address, place ID, or zone ID (see the Pickup Refinement section for more details).
- Product Type: Specify the product (e.g., UberX).
¶ Optional but Important Fields
Fare: Use the unique fare ID (fare_id
) from the estimates response to lock in the upfront fare(Required to lock in an upfront fare).
Scheduling:
- On-Demand: If no scheduling information is provided, the ride is requested immediately.
- Scheduled: Use
scheduling.pickup_time
to set the ride for a future date and time (timestamp in milliseconds). - Flexible: Use
deferred_ride_options.pickup_day
(YYYY-MM-DD format) to allow the rider to request the ride on a specific day. The rider will receive instructions via SMS to request the ride when ready.
¶ Other Optional Fields
- Guest Locale: Customize the language of SMS communications using
guest.locale
. Default isen_US
. - Expense Memo: Use
expense_memo
to describe the purpose of the trip or add internal notes. These will appear in the CSV report. - Sender Display Name: Customize the name in the SMS (
sender_display_name
). This name appears as the sender of the ride, with a maximum of 26 characters. Defaults is theorganization name
. - Note for Driver: Use
note_for_driver
to send specific pickup or trip details directly to the driver. This information will not be visible to the rider. - Call Enabled: If set to
true
, Uber will call the rider with trip details. If this field is not provided, it defaults totrue
. - Contacts to Notify: Use this object to notify a third-party contact via SMS with the trip link.
- Return Trips: You can create a return trip within the same API request by specifying the relevant fields in
return_trip_params
.