Skip to navigation
Dice Standardized APIs V2 CopyTrip

Cancel Trip

View as Markdown

Cancel Trip

Cancels a trip. A trip that is already cancelled, or that has active bookings / claims attached, cannot be cancelled; cancel those bookings first. remarks is stored as the cancellation reason.

Request Parameters

ParamRequiredDescription
tripIdMandatoryTrip reference to cancel (as returned by Create Trip).
employeeCodeConditionalEmployee code of the trip owner. One of employeeCode or employeeEmail is mandatory; the code wins if both are sent.
employeeEmailConditionalEmail of the trip owner. Used when employeeCode is not sent.
remarksOptionalReason for cancellation. Stored on the trip.

Headers

DICE-APP-IDstringOptional
Company Code of client
X-CLIENT-IDstringOptional
API Client ID
X-CLIENT-SECRETstringOptional
API Client Secret

Request

Cancel Trip request body.
tripIdstringRequired

Trip reference to cancel (as returned by Create Trip).

employeeCodestringOptional

Employee code of the trip owner. One of employeeCode / employeeEmail is mandatory; the code wins if both are sent.

employeeEmailstringOptionalformat: "email"

Email of the trip owner. Used when employeeCode is not sent.

remarksstringOptional
Reason for cancellation. Stored on the trip.

Response

OK
successboolean

true when the operation succeeded.

dataobjectOptional

Reserved (internal envelope). Ignore.

safebooleanOptional
Reserved. Ignore.