Adjust a booking's price or commission (admin-only)
POST/v2/bookings/{id}/adjust-pricing
Requires your API key in the X-API-Key header.
Manually corrects a booking's pricing. At least one of the two fields must be sent.
finalPriceAmount— only when the payment was collected by the property (notTURNEO/TURNEO_LINK/RESELLER_CARD— re-pricing a gateway charge would desync it).netRatescales to preserve the commission fraction; payout fields recompute.commission— percent, custom bookings only; recomputesnetRateand updates the custom experience's commission.
A booking already carrying a discount or voucher cannot be re-priced (400), and neither can a booking in a month whose organizer statement has already been invoiced (closed accounting period).
Side effects
Recorded on the activity feed (booking.price_changed, with old→new amounts
and the acting user). Organizer and reseller receive the booking-modified
notification (no guest email — pricing is payout bookkeeping).
curl -X POST "https://api.turneo.co/v2/bookings/0b7f5f7e-1234-4c56-89ab-4d5e6f7a8b9c/adjust-pricing" \
-H "X-API-Key: <your-api-key>" \
-H "Content-Type: application/json" \
-d '{
"finalPriceAmount": 150,
"note": "Guest upgraded on site"
}'Path parameters
idstringrequiredBooking UUID or booking code.
- Example:
0b7f5f7e-1234-4c56-89ab-4d5e6f7a8b9c
Request bodyapplication/json, required
finalPriceAmountnumbernullableNew total price. Only for payments collected by the property (not gateway-charged).
- Limits:
- minimum 0 (exclusive)
- Example:
150
commissionnumbernullableNew commission percent. Custom bookings only.
- Limits:
- minimum 0, maximum 100
- Example:
25
notestringnullableWhy the pricing changed (stored on the activity record).
- Example:
Guest upgraded on site
Example: Correct the price of a property-collected booking
{
"finalPriceAmount": 150,
"note": "Guest upgraded on site"
}Example: Fix a custom booking's commission
{
"commission": 25
}Responses
200object
The booking with updated pricing.
idstring (uuid)Booking UUID.
- Example:
0b7f5f7e-1234-4c56-89ab-4d5e6f7a8b9c
bookingCodestringShort human-friendly booking code, unique per booking. Usable in place of the UUID in every
/v2/bookings/{id}URL.- Example:
AC3F1TT2
bookingStatusstringLifecycle status:
ON_HOLD(in cart),PENDING(awaiting organizer),ACCEPTED,COMPLETED,CANCELLED,EXPIRED,NO_SHOW,REJECTED. (REMOVEDexists internally but is never returned.)- Allowed values:
ON_HOLDPENDINGACCEPTEDCOMPLETEDCANCELLEDEXPIREDNO_SHOWREJECTED- Example:
ACCEPTED
experienceobjectnullableThe booked experience, embedded in full (same shape as the v2 experience read serializer — see the Experiences group for the complete field reference). Key fields listed here.
Child fields
idstring (uuid)Experience UUID.
- Example:
9b2e6c7d-1f2a-4b3c-8d9e-0a1b2c3d4e5f
nameobjectMultilingual experience name keyed by language code.
locationobjectExperience location (city, country, coordinates).
imagesobject[]Experience images.
organizerobjectEmbedded organizer summary (name, partnerId, contact details, rating).
refundPolicyobjectnullableTiered refund policy driving cancellation fees. Null means non-refundable.
cutOffTimeintegerMinimum notice (hours) required to book or reschedule.
- Example:
2
optionobjectnullableThe booked option, embedded in full (same shape as the v2 option read serializer — see the Options group for the complete field reference), including its variants, add-ons and extra fields. Key fields listed here.
Child fields
idstring (uuid)Option UUID.
variantIdandavailabilitySlotIdon the booking reference into this option.- Example:
0d9f4c1a-2b3c-4d5e-8f9a-0b1c2d3e4f5a
nameobjectMultilingual option name.
pricingModelstringPricing model of the option (e.g.
PER_PARTICIPANT,FLAT_RATE,DURATION_BASED).- Example:
PER_PARTICIPANT
durationobjectDefault duration of the option.
Child fields
daysintegerWhole days component.
- Example:
0
hoursintegerHours component.
- Example:
1
minutesintegerMinutes component.
- Example:
30
variantsobject[]The option's variants with their pricing tiers / participant prices.
addonsobject[]Add-ons purchasable with this option.
extraFieldsobject[]Custom booking questions configured on the option (
extraFieldResponsesanswers reference these by id).
variantIdstring (uuid)UUID of the booked variant — references into the embedded
option.variants.- Example:
1e2f3a4b-5c6d-4e7f-8a9b-0c1d2e3f4a5b
availabilitySlotIdstring (uuid)UUID of the booked availability slot.
- Example:
2f3a4b5c-6d7e-4f8a-9b0c-1d2e3f4a5b6c
orderIdstring (uuid)UUID of the order (cart) the booking belongs to.
- Example:
3a4b5c6d-7e8f-4a9b-0c1d-2e3f4a5b6c7d
redeemedRetailItemIdstring (uuid)nullableThe gift voucher's retail item this booking is redeemed with, or null.
- Example:
6c7d8e9f-0a1b-4c2d-8e3f-4a5b6c7d8e9f
timestring (date-time)Booking start as an absolute UTC timestamp (computed from the local slot time and the experience timezone).
- Example:
2026-07-14T08:00:00Z
slotStartTimeobjectBooking start in the experience's local timezone.
Child fields
datestring (date)Local calendar date (
YYYY-MM-DD).- Example:
2026-07-14
timestringnullableLocal wall-clock time (
HH:MM:SS). Null for date-only (all-day) slots.- Example:
10:00:00
slotEndTimeobjectnullableBooking occupancy end (local). Derived from the resolved resource window when resources are assigned (cleanup buffers excluded), otherwise start +
bookedDuration. Null when neither is known (e.g. an all-day date-only slot).Child fields
datestring (date)Local calendar date (
YYYY-MM-DD).- Example:
2026-07-14
timestringnullableLocal wall-clock time (
HH:MM:SS). Null for date-only (all-day) slots.- Example:
10:00:00
participantCountsmap of integerMap of participant-type UUID → booked count.
totalParticipantsintegerSum of participant counts, excluding capacity-exempt types (e.g. infants).
- Example:
2
bookedDurationobjectnullableTotal booked duration. For duration-based options this is
durationIncrement × durationUnits; otherwise a snapshot of the option duration at booking time.Child fields
daysintegerWhole days component.
- Example:
0
hoursintegerHours component.
- Example:
1
minutesintegerMinutes component.
- Example:
30
durationUnitsintegernullableNumber of duration-increment blocks booked. Null for non-DURATION_BASED options.
finalPriceobjectTotal retail price charged to the traveler (after discounts).
Child fields
amountnumberAmount in major currency units.
- Example:
100
currencystringISO 4217 currency code.
- Example:
EUR
basePriceobjectSum of the BASE lines of the price breakdown (before add-ons and discounts).
Child fields
amountnumberAmount in major currency units.
- Example:
100
currencystringISO 4217 currency code.
- Example:
EUR
netRateobjectOrganizer's payout amount (retail minus commission).
Child fields
amountnumberAmount in major currency units.
- Example:
100
currencystringISO 4217 currency code.
- Example:
EUR
retailPriceBreakdownobject[]nullableLine-by-line retail price breakdown (base lines, add-ons, discounts).
Child fields
labelstringHuman-readable line label, in the booking's language (e.g. a participant type or add-on name).
- Example:
Adult
quantityintegerNumber of units on this line.
- Example:
2
unitPricenumberPer-unit price.
- Example:
50
retailPriceobjectLine total (
unitPrice×quantity).Child fields
amountnumberAmount in major currency units.
- Example:
100
currencystringISO 4217 currency code.
- Example:
EUR
typestringLine kind:
BASE(participant/tier pricing),ADDONorDISCOUNT(negative).- Allowed values:
BASEADDONDISCOUNT- Example:
BASE
bookingAddonsobject[]Add-ons purchased with the booking.
Child fields
addonIdstring (uuid)UUID of the option add-on.
- Example:
7a8b9c0d-1e2f-4a3b-8c9d-0e1f2a3b4c5d
addonNamestringAdd-on name, localized to the request language (falling back to the booking language).
- Example:
Hotel transfer
quantityintegerEffective quantity booked. For per-person checkbox add-ons this is derived from the participant count.
- Example:
2
pricestringnullablePer-unit add-on price as a decimal string. Null for free add-ons.
- Example:
15.00
perPersonbooleanWhether the add-on is priced per participant.
- Example:
true
extraFieldResponsesmap of stringnullableAnswers to the option's custom booking questions, keyed by extra-field UUID.
storeExtraFieldResponsesobjectnullableAnswers to the store's checkout questions, keyed by question id; each value is a string, a boolean (checkbox) or null. The questions themselves are defined on the store config (
checkout.questions), not on the option, and are answered once per order — every booking of an order carries the same map. Returned only to the booking's reseller; null for everyone else, organizer-side callers included.alternativeSlotsobject[]nullableAlternative slots currently offered by the organizer (see the reject endpoint). Null when none are pending.
Child fields
idstring (uuid)Availability-slot UUID — pass this to
POST /v2/bookings/{id}/accept-alternative.- Example:
3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f
startDatestring (date)Local start date of the offered slot.
- Example:
2026-07-15
startTimestringnullableLocal start time of the offered slot. Null for date-only slots.
- Example:
14:00:00
resellerobjectThe selling partner, enriched with point-of-sale metadata captured at booking time (store, agent, hotel/room) when present.
Child fields
namestringReseller partner display name.
- Example:
Hotel Adriatic
partnerIdstringReseller's public partner ID.
- Example:
hotel-adriatic
logostringnullableURL of the reseller's logo.
- Example:
https://cdn.turneo.com/logos/hotel-adriatic.png
featureFlagsobjectFeature flags enabled for this partner.
storeIdstringID of the store (widget/website) the booking was made through. Only present when captured.
- Example:
store-123
storeNamestringDisplay name of the store. Only present when captured.
- Example:
Lobby Desk
storeSubdomainstringSubdomain of the store. Only present when captured.
- Example:
lobby
agentNamestringName of the concierge agent who made the booking. Only present when captured.
- Example:
Marta
agentReferencestringAgent's own reference for the booking. Only present when captured.
- Example:
AG-42
hotelNamestringHotel name captured at booking time. Only present when captured.
- Example:
Turneo Hotel
roomNumberstringGuest's room number captured at booking time. Only present when captured.
- Example:
204
resellerReferencestringnullableReseller's internal reference for the booking.
- Example:
PMS-42
resellerPropertyobjectnullableThe reseller's property (hotel) the booking is associated with. Null when not linked.
Child fields
idstring (uuid)Property UUID.
- Example:
5f6a7b8c-9d0e-4f1a-2b3c-4d5e6f7a8b9c
namestringProperty display name.
- Example:
Hotel Adriatic Split
locationobjectnullableProperty location (address, city, country, coordinates).
partnerstringnullableOwning partner reference.
- Example:
hotel-adriatic
parentPropertystring (uuid)nullableParent property UUID for property hierarchies.
roomCountintegernullableNumber of rooms at the property.
- Example:
120
pmsIntegrationobjectnullablePMS connection summary. Null when the property has no PMS integration.
Child fields
enabledbooleanWhether the PMS integration is active.
- Example:
true
providerstringPMS provider (e.g.
Mews,Apaleo,Oracle Opera).- Example:
Mews
pmsBookingIdstringnullableIdentifier of the booking in the hotel's PMS, when synced.
- Example:
MEWS-778812
travelerInformationobjectnullableMain traveler contact details.
Child fields
firstNamestringTraveler's first name.
- Example:
Ada
lastNamestringTraveler's last name.
- Example:
Lovelace
emailstring (email)Traveler's email address — used for all guest-facing emails (confirmations, tickets, review requests).
- Example:
ada.lovelace@example.com
phonestringTraveler's phone number, international format recommended.
- Example:
+385911234567
paymentobjectnullableHow and whether the booking was paid.
Child fields
processedBystringnullableWho collects the payment.
TURNEO(Stripe via Turneo — the only kind eligible for automatic capture/refund),TURNEO_LINK(payment link),RESELLER_CONCIERGE,RESELLER_ROOM(charged to the hotel room),RESELLER_CARD,RESELLER_DEFERRED(pay on site, settled via invoicing),ORGANIZER,PMS_ROOM_CHARGE,RETAIL_VOUCHER(paid with a gift voucher; the booking is priced at 0 andstatusisFREE), or the deprecatedRESELLER. Null when not yet determined.- Allowed values:
TURNEOTURNEO_LINKRESELLER_CONCIERGERESELLER_ROOMRESELLER_CARDRESELLER_DEFERREDORGANIZERPMS_ROOM_CHARGERETAIL_VOUCHERRESELLER- Example:
TURNEO
statusstringPAYMENT_PENDING,PAYMENT_COLLECTED,REFUNDEDorFREE.- Allowed values:
PAYMENT_PENDINGPAYMENT_COLLECTEDREFUNDEDFREE- Example:
PAYMENT_COLLECTED
codestringnullablePayment reference code (e.g. gateway transaction reference). Often null.
- Example:
ch_3PqX1...
meetingPointobjectnullableThe pickup/meeting arrangement selected for this booking.
Child fields
typestringCENTRAL_MEETING_POINTorHOTEL_PICKUP.- Allowed values:
CENTRAL_MEETING_POINTHOTEL_PICKUP- Example:
CENTRAL_MEETING_POINT
titlestringDisplay name of the meeting point.
- Example:
Main square fountain
addressstringStreet address of the meeting point.
- Example:
1 Main Street, Split
descriptionstringExtra instructions for finding the meeting point.
- Example:
Look for the red umbrella
timeBeforeStartintegerHow many minutes before the experience start the traveler should arrive.
- Example:
15
voucherobjectnullableSeller discount voucher applied to the booking (via the order voucher endpoints). Null when none was used.
Child fields
codestringVoucher code.
- Example:
SUMMER20
discountPercentintegerPercentage discount granted by the voucher.
- Example:
20
discountobjectnullableAutomatic discount applied at booking time. Null when no discount applied.
Child fields
percentageAmountintegerPercentage discount applied.
- Example:
10
typestringDiscount kind, e.g.
EARLY_BIRDorAVAILABILITY.- Example:
EARLY_BIRD
conciergeDiscountobjectnullableAd-hoc discount applied by a concierge at checkout. Null when none applied.
reviewobjectnullableThe booking's review (the accepted one if present, otherwise the first). Null when the booking has no reviews.
Child fields
idstring (uuid)Review UUID.
- Example:
8b9c0d1e-2f3a-4b4c-9d0e-1f2a3b4c5d6e
ratingintegerStar rating, 1–5.
- Example:
5
reviewTextstringnullableReview text.
- Example:
Great tour, amazing guide!
reviewTextOriginalstringnullableOriginal (untranslated) review text.
- Example:
Great tour, amazing guide!
internalFeedbackstringnullablePrivate feedback for the organizer — never shown publicly.
- Example:
Guide was excellent
tagsstring[]Names of tags attached to the review.
reviewerNamestringnullableReviewer's display name; falls back to the traveler's first name.
- Example:
Ada Lovelace
reviewDatestringReview date (
YYYY-MM-DD, or the creation timestamp when no explicit date was given).- Example:
2026-07-01
sourcestringresellerwhen posted by the booking's reseller, otherwiseother.- Allowed values:
resellerother- Example:
reseller
storeIdstringnullableStore the review was posted from (reseller-posted reviews only).
- Example:
store-123
statusstringModeration status:
PENDING,ACCEPTEDorREJECTED.- Allowed values:
PENDINGACCEPTEDREJECTED- Example:
ACCEPTED
insightfulnessScorenumbernullableAI-scored insightfulness of the review text.
- Example:
0.82
resourcesobject[]Resources assigned to the booking (deduplicated — one entry per resource even across multiple time blocks).
Child fields
idstring (uuid)Resource UUID.
- Example:
3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f
namestringResource display name.
- Example:
Padel court 1
colorstringnullableDisplay color used in calendar UIs.
- Example:
#FF8800
typestringnullableOrganizer-defined resource type.
- Example:
COURT
bookingSourcestringnullableIdentifier of the channel that created the booking (e.g. store widget, concierge hub).
- Example:
experience-store
emailNotificationstring (email)[]nullableExtra email addresses notified about this booking.
metadataobjectnullableArbitrary JSON metadata attached at creation (store/agent context, external provider IDs, ...).
languagestringLanguage code of the booking — used for guest-facing emails and localized names.
- Example:
en
cancellationobjectnullableCancellation details. Null unless the booking is
CANCELLED.Child fields
cancelledBystringWho cancelled the booking.
- Allowed values:
TravelerOrganizerResellerAdmin- Example:
Traveler
cancelledAtstringWhen the cancellation happened, as a naive local timestamp in the experience's timezone.
- Example:
2026-07-10T14:30:00
cancelledReasonstringnullableFree-text reason supplied by the canceller.
- Example:
Change of plans
cancellationFeeAmountnumberFee retained from the traveler. 0 means a full refund; the full price means non-refundable.
- Example:
25
cancellationFeeCurrencystringCurrency of the cancellation fee (the booking's currency).
- Example:
EUR
refundPercentagenumberThe refund-policy tier percentage that was applied. Absent when the fee was forced to 0 (organizer cancel, or traveler cancel after alternatives were offered).
- Example:
75
notesobjectnullableOne note per author role. Null when the booking has no notes.
Child fields
fromSellerstringNote written by the reseller (concierge).
- Example:
Guest asked for a vegetarian lunch
fromOrganizerstringNote written by the organizer (e.g. a rejection reason).
- Example:
Meet at the side entrance
fromTravelerstringNote left by the traveler.
- Example:
We'll be 5 minutes late
createdAtstring (date-time)When the booking was created (UTC).
- Example:
2026-06-30T09:12:00Z
updatedAtstring (date-time)When the booking was last modified (UTC).
- Example:
2026-07-01T10:00:00Z
{
"id": "0b7f5f7e-1234-4c56-89ab-4d5e6f7a8b9c",
"bookingCode": "AC3F1TT2",
"bookingStatus": "ACCEPTED",
"experience": {
"id": "9b2e6c7d-1f2a-4b3c-8d9e-0a1b2c3d4e5f",
"name": {
"en": "Split Old Town Walking Tour"
},
"location": {
"city": "Split",
"country": "Croatia"
},
"images": [
{
"url": "https://cdn.turneo.com/img/tour.jpg",
"position": 0
}
],
"organizer": {
"name": "Split Tours",
"partnerId": "split-tours"
},
"refundPolicy": {
"tiers": [
{
"hoursBeforeStart": 24,
"refundPercentage": 100
},
{
"hoursBeforeStart": 0,
"refundPercentage": 0
}
]
},
"cutOffTime": 2
},
"option": {
"id": "0d9f4c1a-2b3c-4d5e-8f9a-0b1c2d3e4f5a",
"name": {
"en": "Morning departure"
},
"pricingModel": "PER_PARTICIPANT",
"duration": {
"days": 0,
"hours": 1,
"minutes": 30
},
"variants": [
{}
],
"addons": [
{}
],
"extraFields": [
{}
]
},
"variantId": "1e2f3a4b-5c6d-4e7f-8a9b-0c1d2e3f4a5b",
"availabilitySlotId": "2f3a4b5c-6d7e-4f8a-9b0c-1d2e3f4a5b6c",
"orderId": "3a4b5c6d-7e8f-4a9b-0c1d-2e3f4a5b6c7d",
"redeemedRetailItemId": "6c7d8e9f-0a1b-4c2d-8e3f-4a5b6c7d8e9f",
"time": "2026-07-14T08:00:00Z",
"slotStartTime": {
"date": "2026-07-14",
"time": "10:00:00"
},
"slotEndTime": {
"date": "2026-07-14",
"time": "10:00:00"
},
"participantCounts": {
"6f7a8b9c-0d1e-4f2a-3b4c-5d6e7f8a9b0c": 2
},
"totalParticipants": 2,
"bookedDuration": {
"days": 0,
"hours": 1,
"minutes": 30
},
"durationUnits": null,
"finalPrice": {
"amount": 100,
"currency": "EUR"
},
"basePrice": {
"amount": 100,
"currency": "EUR"
},
"netRate": {
"amount": 100,
"currency": "EUR"
},
"retailPriceBreakdown": [
{
"label": "Adult",
"quantity": 2,
"unitPrice": 50,
"retailPrice": {
"amount": 100,
"currency": "EUR"
},
"type": "BASE"
}
],
"bookingAddons": [
{
"addonId": "7a8b9c0d-1e2f-4a3b-8c9d-0e1f2a3b4c5d",
"addonName": "Hotel transfer",
"quantity": 2,
"price": "15.00",
"perPerson": true
}
],
"extraFieldResponses": {
"5d6e7f8a-9b0c-4d1e-2f3a-4b5c6d7e8f9a": "No allergies"
},
"storeExtraFieldResponses": {
"0d2e4f6a-8b0c-4d2e-9f1a-3b5c7d9e1f2a": "Room 204",
"7c8d9e0f-1a2b-4c3d-8e9f-0a1b2c3d4e5f": true
},
"alternativeSlots": [
{
"id": "3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
"startDate": "2026-07-15",
"startTime": "14:00:00"
}
],
"reseller": {
"name": "Hotel Adriatic",
"partnerId": "hotel-adriatic",
"logo": "https://cdn.turneo.com/logos/hotel-adriatic.png",
"featureFlags": {},
"storeId": "store-123",
"storeName": "Lobby Desk",
"storeSubdomain": "lobby",
"agentName": "Marta",
"agentReference": "AG-42",
"hotelName": "Turneo Hotel",
"roomNumber": "204"
},
"resellerReference": "PMS-42",
"resellerProperty": {
"id": "5f6a7b8c-9d0e-4f1a-2b3c-4d5e6f7a8b9c",
"name": "Hotel Adriatic Split",
"location": {
"city": "Split",
"country": "Croatia"
},
"partner": "hotel-adriatic",
"parentProperty": null,
"roomCount": 120,
"pmsIntegration": {
"enabled": true,
"provider": "Mews"
}
},
"pmsBookingId": "MEWS-778812",
"travelerInformation": {
"firstName": "Ada",
"lastName": "Lovelace",
"email": "ada.lovelace@example.com",
"phone": "+385911234567"
},
"payment": {
"processedBy": "TURNEO",
"status": "PAYMENT_COLLECTED",
"code": "ch_3PqX1..."
},
"meetingPoint": {
"type": "CENTRAL_MEETING_POINT",
"title": "Main square fountain",
"address": "1 Main Street, Split",
"description": "Look for the red umbrella",
"timeBeforeStart": 15
},
"voucher": {
"code": "SUMMER20",
"discountPercent": 20
},
"discount": {
"percentageAmount": 10,
"type": "EARLY_BIRD"
},
"conciergeDiscount": null,
"review": {
"id": "8b9c0d1e-2f3a-4b4c-9d0e-1f2a3b4c5d6e",
"rating": 5,
"reviewText": "Great tour, amazing guide!",
"reviewTextOriginal": "Great tour, amazing guide!",
"internalFeedback": "Guide was excellent",
"tags": [
"guide",
"value"
],
"reviewerName": "Ada Lovelace",
"reviewDate": "2026-07-01",
"source": "reseller",
"storeId": "store-123",
"status": "ACCEPTED",
"insightfulnessScore": 0.82
},
"resources": [
{
"id": "3c4d5e6f-7a8b-4c9d-0e1f-2a3b4c5d6e7f",
"name": "Padel court 1",
"color": "#FF8800",
"type": "COURT"
}
],
"bookingSource": "experience-store",
"emailNotification": [
"concierge@hotel.example"
],
"metadata": {
"store_id": "store-123",
"store_name": "Lobby Desk"
},
"language": "en",
"cancellation": {
"cancelledBy": "Traveler",
"cancelledAt": "2026-07-10T14:30:00",
"cancelledReason": "Change of plans",
"cancellationFeeAmount": 25,
"cancellationFeeCurrency": "EUR",
"refundPercentage": 75
},
"notes": {
"fromSeller": "Guest asked for a vegetarian lunch",
"fromOrganizer": "Meet at the side entrance",
"fromTraveler": "We'll be 5 minutes late"
},
"createdAt": "2026-06-30T09:12:00Z",
"updatedAt": "2026-07-01T10:00:00Z"
}Errors
- 400
Validation failed. Inspect
errors[].fieldanderrors[].code.- 401
Missing or invalid
X-API-Keyheader.- 403
The API key is valid but not allowed to perform this action on this resource.
- 404
The resource does not exist or belongs to another partner (existence is not leaked across partners).
Error body
typestringError class.
- Allowed values:
validation_errorclient_errorserver_error- Example:
validation_error
errorsobject[]Child fields
codestringMachine-readable error code.
- Example:
required
fieldstringnullableOffending field, or null/'general' for non-field errors.
- Example:
startTime
messagestringHuman-readable message.
- Example:
This field is required.
{
"type": "validation_error",
"errors": [
{
"code": "required",
"field": "startTime",
"message": "This field is required."
}
]
}