Skip to content

Update pickup information

PUT/journeys/{id}/pickup-info

Auth: X-API-Key headerhttps://warpdrive.staging.transferz.com/transfercompanies

Updated pickup information for the given journey

Updates where (and for shared rides, when) the traveller is picked up: the pickup location with a description the traveller sees, for example a specific door or bus bay. Changing the pickup time is only allowed for shared journeys.

Guide: Update pickup information for shared journeys

Path parameters

  • idinteger · int64required

    The id of the journey to update

Headers

  • X-Request-IDstring

    The optional (ideally unique) request identifier used for later analysis or diagnostics

Request body

application/json · required

  • pickupTimestring · date-time

    New pickup time (shared journeys only).

  • pickupLocationobject

    Where exactly the traveller is picked up.

Responses

No content

Errors this endpoint can return

  • 400, failedINVALID_REQUEST

    When: pickupLocation lacks a description, latitude or longitude.

    What to do: Read message, correct the request and send it again.

  • 400, failedUNKNOWN

    When: A pickup time was sent for a private journey, or the journey is not CONFIRMED, PLANNED or DRIVER_UNDERWAY.

    What to do: For 400, read message and correct the request. For 500, retry once; if it persists, contact Transferz support with the X-Request-ID you sent.

  • When: The journey is not assigned to your company (also returned for an unknown id).

    What to do: Check that the id belongs to your company and that you use the key of the right user. Ask Transferz to check the account's permissions if the id is correct.