Skip to content

Replace one closed reservation draft step at the expected revision

PATCH
/customer-reservation-drafts/{draftId}
curl --request PATCH \
--url https://example.com/customer-reservation-drafts/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: example' \
--data '{ "expectedRevision": 1, "stepKey": "applicant_authority", "stepInput": "example" }'
draftId
required
string
>= 1 characters <= 512 characters /.*\S.*/
Idempotency-Key
required
string
>= 1 characters <= 255 characters /.*\S.*/
Media typeapplication/json
One of:
CustomerReservationDraftStepPatch
object
expectedRevision
required
integer
>= 1
stepKey
required
Allowed value: applicant_authority
stepInput
required
object
reservationCreationIntent
required
string
Allowed values: new_reservation extension
extensionSourceReservationSelectionReference
required

Opaque server-issued selectionReference from the eligible extension source reservation catalog; never a raw reservation id.

string | null
>= 1 characters
/^[0-9]+$/
sponsorshipReference
required
string | null
>= 1 characters
delegatedPaymentReference
required
string | null
>= 1 characters
key
additional properties
key
additional properties

Draft step saved at the next revision with downstream invalidations

Media typeapplication/json
CustomerReservationDraft
object
draftId
required
string
>= 1 characters <= 512 characters /\S/
ownerSubjectReference
required
string
>= 1 characters <= 512 characters /\S/
revision
required
integer
>= 1
expiresAt
required
string format: date-time
stepInputs
required
object
applicant_authority
object
reservationCreationIntent
required
string
Allowed values: new_reservation extension
extensionSourceReservationSelectionReference
required

Opaque server-issued selectionReference from the eligible extension source reservation catalog; never a raw reservation id.

string | null
>= 1 characters
/^[0-9]+$/
sponsorshipReference
required
string | null
>= 1 characters
delegatedPaymentReference
required
string | null
>= 1 characters
key
additional properties
mother_contact
object
email
required
string format: email
phone
required
string
>= 1 characters <= 512 characters /\S/
birthDate
required
string format: date
emergencyContact
required
One of:
object
phone
required
string
>= 1 characters <= 512 characters /\S/
relationshipCode
required
string
/^[a-z][a-z0-9_.:-]*$/
relationshipDetail
required
string | null
>= 1 characters
key
additional properties
key
additional properties
service_addresses
object
homeAddress
required
Any of:
object
sido
required
string
>= 1 characters <= 512 characters /\S/
sigungu
required
string | null
>= 1 characters
bname
required
string | null
>= 1 characters
zonecode
required
string | null
>= 1 characters
roadAddress
required
string
jibunAddress
required
string | null
>= 1 characters
addressDetail
required
string | null
>= 1 characters
key
additional properties
serviceAddress
required
Any of:
object
sido
required
string
>= 1 characters <= 512 characters /\S/
sigungu
required
string | null
>= 1 characters
bname
required
string | null
>= 1 characters
zonecode
required
string | null
>= 1 characters
roadAddress
required
string
jibunAddress
required
string | null
>= 1 characters
addressDetail
required
string | null
>= 1 characters
key
additional properties
secondaryServiceAddress
required
One of:
Any of:
object
sido
required
string
>= 1 characters <= 512 characters /\S/
sigungu
required
string | null
>= 1 characters
bname
required
string | null
>= 1 characters
zonecode
required
string | null
>= 1 characters
roadAddress
required
string
jibunAddress
required
string | null
>= 1 characters
addressDetail
required
string | null
>= 1 characters
key
additional properties
key
additional properties
birth_and_babies
object
birthState
required
string
Allowed values: expected completed
birthDate
required
string format: date
deliveryTypeOptionKey
required
string
/^[a-z][a-z0-9_.:-]*$/
babyTypeOptionKey
required
string
/^[a-z][a-z0-9_.:-]*$/
babies
required
Array<object>
>= 1 items <= 4 items
object
sequence
required
integer
>= 1 <= 4
name
required
string | null
>= 1 characters
weightGrams
required
integer | null
>= 1
genderOptionKey
required
string
/^[a-z][a-z0-9_.:-]*$/
key
additional properties
olderChildCountOptionKey
required
string
/^[a-z][a-z0-9_.:-]*$/
careCenterTermOptionKey
required
string
/^[a-z][a-z0-9_.:-]*$/
key
additional properties
care_environment
object
pets
required
Array<object>
object
speciesCode
required
string
/^[a-z][a-z0-9_.:-]*$/
speciesDetail
required
string | null
>= 1 characters
count
required
integer
>= 1
sizeCode
required
string | null
/^[a-z][a-z0-9_.:-]*$/
key
additional properties
petsSeparatedFromNewbornDuringService
required

Reservation-wide separation intent. true preserves legacy pet_together=1, meaning pets are kept separate from the newborn during service.

boolean | null
key
additional properties
service_offering
object
serviceOfferingKey
required
string
/^[a-z][a-z0-9_.:-]*$/
voucherRecipientIdentityEvidenceKey
required
string | null
>= 1 characters
/^[0-9-]+$/
voucherDeliveryRankAndWorkforceOptionKey
required
string | null
/^[a-z][a-z0-9_.:-]*$/
voucherIncomeTypeOptionKey
required
string | null
/^[a-z][a-z0-9_.:-]*$/
key
additional properties
service_schedule
object
desiredServiceStartOn
required
string format: date
serviceDurationOptionKey
required
string | null
/^[a-z][a-z0-9_.:-]*$/
workScheduleOptionKey
required
string | null
/^[a-z][a-z0-9_.:-]*$/
voucherServiceDayOptionKey
required
string | null
/^[a-z][a-z0-9_.:-]*$/
preferredSaturdayServiceDates
required
Array<string>
unique items
preferredHolidayServiceDates
required
Array<string>
unique items
key
additional properties
additional_services
object
serviceOptions
required
Array<object>
object
optionKey
required
string
/^[a-z][a-z0-9_.:-]*$/
quantity
required
integer
>= 1
key
additional properties
rentalOptionKeys
required
Array<string>
unique items
key
additional properties
caregiver_matching
object
religionOptionKey
required
string | null
/^[a-z][a-z0-9_.:-]*$/
religionDetail
required
string | null
>= 1 characters
priorityOptionKeys
required
Array<string>
<= 3 items unique items
personalityOptionKeys
required
Array<string>
unique items
note
required
string | null
>= 1 characters
namedCaregiverRequestText
required
string | null
>= 1 characters
caregiverRecommendationSelectionIntent
required
object
selectionMode
required
string
Allowed values: backend_recommendation specific_recommendation named_request
decisionReference
required
string | null
>= 1 characters
expectedDecisionRevision
required
integer | null
>= 1
recommendedCaregiverReference
required
string | null
>= 1 characters
key
additional properties
key
additional properties
contract_and_payment_preference
object
paymentMethodCode
required
string
Allowed values: card bank vcnt
requestedSupportProgramKeys
required
Array<string>
unique items
requestedPromotionEntitlementReferences
required
Array<string>
unique items
key
additional properties
key
additional properties
completedStepKeys
required
Array<string>
unique items
Allowed values: applicant_authority mother_contact service_addresses birth_and_babies care_environment service_offering service_schedule additional_services caregiver_matching contract_and_payment_preference
nextRequiredStepKey
required
One of:
string
Allowed values: applicant_authority mother_contact service_addresses birth_and_babies care_environment service_offering service_schedule additional_services caregiver_matching contract_and_payment_preference final_review
editableStepKeys
required
Array<string>
unique items
Allowed values: applicant_authority mother_contact service_addresses birth_and_babies care_environment service_offering service_schedule additional_services caregiver_matching contract_and_payment_preference
stepOptionCatalogs
required
Array<object>
object
stepKey
required
string
Allowed values: applicant_authority mother_contact service_addresses birth_and_babies care_environment service_offering service_schedule additional_services caregiver_matching contract_and_payment_preference
catalogKey
required
string
Allowed values: applicant_authority.sponsorship_references applicant_authority.delegated_payment_references applicant_authority.eligible_extension_source_reservations mother_contact.emergency_relationships birth.delivery_types birth.baby_types birth.baby_genders birth.older_child_counts birth.care_center_terms care_environment.pet_species care_environment.pet_sizes service_offering.offerings service_offering.voucher_delivery_rank_and_workforce service_offering.voucher_income_types service_schedule.durations service_schedule.work_schedules service_schedule.voucher_service_days additional_services.service_options additional_services.rental_options caregiver_matching.religions caregiver_matching.priorities caregiver_matching.personalities caregiver_matching.recommendations contract_and_payment_preference.payment_methods contract_and_payment_preference.support_programs contract_and_payment_preference.promotion_entitlements
fieldPath
required
string
Allowed values: applicant_authority.sponsorshipReference applicant_authority.delegatedPaymentReference applicant_authority.extensionSourceReservationSelectionReference mother_contact.emergencyContact.relationshipCode birth_and_babies.deliveryTypeOptionKey birth_and_babies.babyTypeOptionKey birth_and_babies.babies.genderOptionKey birth_and_babies.olderChildCountOptionKey birth_and_babies.careCenterTermOptionKey care_environment.pets.speciesCode care_environment.pets.sizeCode service_offering.serviceOfferingKey service_offering.voucherDeliveryRankAndWorkforceOptionKey service_offering.voucherIncomeTypeOptionKey service_schedule.serviceDurationOptionKey service_schedule.workScheduleOptionKey service_schedule.voucherServiceDayOptionKey additional_services.serviceOptions additional_services.rentalOptionKeys caregiver_matching.religionOptionKey caregiver_matching.priorityOptionKeys caregiver_matching.personalityOptionKeys caregiver_matching.caregiverRecommendationSelectionIntent.recommendedCaregiverReference contract_and_payment_preference.paymentMethodCode contract_and_payment_preference.requestedSupportProgramKeys contract_and_payment_preference.requestedPromotionEntitlementReferences
valueSource
required
string
Allowed values: option_key selection_reference
authorityReference
required
string | null
>= 1 characters
authorityRevision
required
integer | null
>= 1
revision
required
string
>= 1 characters <= 512 characters /\S/
options
required
Array<object>
object
optionKey
required
string
/^[a-z][a-z0-9_.:-]*$/
selectionReference
required
string | null
>= 1 characters
label
required
string
>= 1 characters <= 512 characters /\S/
disabled
required
boolean
disabledReasonCodes
required
Array<string>
unique items
quantityBounds
required
One of:
object
minimum
required
integer
maximum
required
integer
key
additional properties
dateBounds
required
One of:
object
minimumOn
required
string format: date
maximumOn
required
string | null format: date
key
additional properties
key
additional properties
One of:
object
stepKey
Allowed value: applicant_authority
catalogKey
Allowed value: applicant_authority.sponsorship_references
fieldPath
Allowed value: applicant_authority.sponsorshipReference
key
additional properties
sourceCatalogRevisions
required
Array<object>
object
catalogCode
required
string
/^[a-z][a-z0-9_.:-]*$/
revision
required
string
>= 1 characters <= 512 characters /\S/
key
additional properties
validationResults
required
Array<object>
object
fieldPath
required
string
/^[a-z][A-Za-z0-9_.:\[\]-]*$/
resultCode
required
string
/^[a-z][a-z0-9_.:-]*$/
messageKey
required
string
/^[a-z][a-z0-9_.:-]*$/
key
additional properties
downstreamInvalidationSet
required
Array<string>
unique items
Allowed values: branch_coverage service_plan service_calendar additional_services rental_options caregiver_candidate_decision price_quote support_decisions payment_preparation contract_review final_review
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
key
additional properties

Supabase bearer token is required

Authenticated principal does not own this draft

Customer reservation draft was not found

Draft revision, expiry, or idempotency facts conflict

Media typeapplication/json
CustomerReservationCreationConflict
object
conflictCode
required
string
Allowed values: draft_revision_mismatch draft_expired idempotency_key_reused final_review_projection_missing final_review_projection_superseded final_review_revision_mismatch authoritative_dependency_changed confirmation_not_ready
draftId
required
string | null
>= 1 characters /\S/
expectedDraftRevision
required
integer | null
>= 1
currentDraftRevision
required
integer | null
>= 1
reservationDraftStepAuthorityProjectionId
required
string | null
>= 1 characters /\S/
expectedReviewRevision
required
integer | null
>= 1
currentReviewRevision
required
integer | null
>= 1
refreshRequired
required
boolean
conflictingFieldPaths
required
Array<string>
unique items
disabledReasonCodes
required
Array<string>
unique items
key
additional properties

Draft step input failed closed field validation without advancing the draft

Media typeapplication/json
CustomerReservationDraftValidationProblem
object
status
required
Allowed value: 422
code
required
Allowed value: customer_reservation_draft_validation_failed
retryable
required
draftId
required
string | null
>= 1 characters /\S/
expectedDraftRevision
required
integer | null
>= 1
currentDraftRevision
required
integer | null
>= 1
stepKey
required
string | null
Allowed values: applicant_authority mother_contact service_addresses birth_and_babies care_environment service_offering service_schedule additional_services caregiver_matching contract_and_payment_preference
fieldErrors
required
Array<object>
>= 1 items unique items
object
fieldPath
required
string
/^[a-z][A-Za-z0-9_.:\[\]-]*$/
resultCode
required
string
/^[a-z][a-z0-9_.:-]*$/
messageKey
required
string
/^[a-z][a-z0-9_.:-]*$/
key
additional properties
key
additional properties

Customer reservation draft command store is unavailable