Renovations

Create sandbox Renovation project

Creates a service-role-only sandbox Renovation project when the authenticated automation client has renovations.projects.write, the Renovation project route gate is enabled, and an Idempotency-Key is provided. External URL: /v1/renovations/current/projects. Current Next.js implementation path: /api/platform/v1/renovations/current/projects. The request accepts partner-generated client and site hashes only; raw client PII, raw site address, supplier pricing, payment state, margin, documents, staff invite, and live action controls stay outside the REST response. Live writes remain unavailable until restricted workspace and live gates pass.

post/renovations/current/projects

Request

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

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

project_slugstring required

Partner-owned project slug. Raw client or site address details stay hashed.

project_namestring required
client_reference_hashstring required

Partner-generated hash; raw client PII is never accepted or returned.

site_reference_hashstring required

Partner-generated hash; raw site address is never accepted or returned.

budget_bandstring nullable
target_start_datestring date nullable
target_completion_datestring date nullable
source_typestring
source_systemstring
source_record_idstring nullable
metadataobject

Optional public-safe metadata. Raw client PII, supplier pricing, and payment state are not allowed.

Response

Sandbox Renovation project response.

livemodefalse required
request_idstring required
idempotency_key_hashstring required

Changes

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