Renovations

Prepare a sandbox Renovation project action for review

Prepares either a variation-order draft or warranty-request checklist when the authenticated automation client has renovations.projects.write, the Renovation project route gate is enabled, confirm_prepare is true, and an Idempotency-Key is provided. External URL: /v1/renovations/current/projects/{projectId}/actions. Current Next.js implementation path: /api/platform/v1/renovations/current/projects/[projectId]/actions. The response requires project-manager review and cannot confirm or execute the action. It does not mutate projects or milestones, create variation orders, submit warranty requests, notify clients, change payment state, make external calls, or expose cost amounts, supplier pricing, client references, or site references. Live preparation remains unavailable.

post/renovations/current/projects/{projectId}/actions

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/renovations/current/projects/{projectId}/actions
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Sandbox Renovation project identifier returned by project list.

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Idempotency-Keystring required

Required for mutating platform routes. Accepted format: 8 to 128 ASCII characters matching [A-Za-z0-9._:-]+.

Request body

action'prepare_variation_order_draft' | 'prepare_warranty_request_checklist' required
confirm_preparetrue required

Explicitly acknowledges preparation of review material only. This does not confirm or execute any Renovation action.

Response

Sandbox Renovation project response.

action'prepare_variation_order_draft' | 'prepare_warranty_request_checklist' required
action_idstring required
status'prepared_for_review' required
required_scope'renovations.projects.write' required
livemodefalse required
request_idstring required
idempotency_key_hashstring required

Changes

No recorded changes to this operation across all 1 revision of this API.