Provider AI

Prepare, confirm, or reject sandbox provider AI actions

Prepares, confirms, or rejects a sandbox provider AI action through the REST API. Missing confirmation returns a safe continuation without writing. Confirmed and rejected actions require an action-specific provider scope, active provider grant, explicit disposition flag, and Idempotency-Key. Rejection records the no-side-effect decision; this route never calls external scheduler, CRM, accounting, DNS, payout, marketplace, or payment systems directly.

post/providers/current/ai/actions

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/providers/current/ai/actions
  • 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

action'prepare_reply' | 'confirm_reply' | 'prepare_website_draft' | 'apply_website_draft' | 'revoke_connection' | 'create_booking_request' required
target_idstring
instructionstring
messagestring
draft_configobject
connection_idstring
provider_grant_status'active' | 'revoked'
confirm_replytrue
confirm_applytrue
confirm_revoketrue
confirm_createtrue
reject_actiontrue
rejection_reasonstring

Response

Prepared, confirmed, or rejected sandbox provider AI action.

oktrue required
action'prepare_reply' | 'confirm_reply' | 'prepare_website_draft' | 'apply_website_draft' | 'revoke_connection' | 'create_booking_request' required
action_idstring required
status'prepared' | 'requires_confirmation' | 'confirmed' | 'rejected' required
required_scope'organizations.read' | 'onboarding.write' | 'credentials.write' | 'listings.read' | 'listings.write' | 'viewings.read' | 'viewings.write' | 'webhooks.read' | 'webhooks.write' | 'sandbox.reset' | 'agent.profile.read' | 'agent.profile.write' | 'agent.listings.read' | 'agent.listings.write' | 'agent.listings.publish' | 'agent.leads.read' | 'agent.leads.write' | 'agent.clients.read' | 'agent.clients.write' | 'agent.viewings.read' | 'agent.viewings.write' | 'agent.distribution.read' | 'agent.distribution.manage' | 'agent.analytics.read' | 'agency.roster.read' | 'agency.roster.manage' | 'agency.teams.manage' | 'agency.listings.read' | 'agency.listings.manage' | 'agency.leads.route' | 'agency.analytics.read' | 'agency.audit.read' | 'agency.integrations.manage' | 'sites.read' | 'sites.write' | 'sites.publish' | 'sites.domains.manage' | 'forms.read' | 'forms.write' | 'forms.submissions.read' | 'scheduling.read' | 'scheduling.write' | 'crm.read' | 'crm.write' | 'crm.sync' | 'widgets.embed' | 'developers.projects.read' | 'developers.projects.write' | 'developers.inventory.read' | 'developers.inventory.write' | 'developers.inventory.publish' | 'developers.prices.read' | 'developers.prices.write' | 'developers.media.write' | 'developers.showflat.read' | 'developers.showflat.write' | 'developers.leads.read' | 'developers.leads.route' | 'renovations.projects.read' | 'renovations.projects.write' | 'development_professional_services.projects.read' | 'valuation_appraisal.cases.read' | 'valuations.read' | 'valuations.embed_keys.read' | 'valuations.embed_keys.write' | 'portfolio.read' | 'property_management.units.read' | 'geospatial.read' | 'insurance_move_in.cases.read' | 'insurance_move_in.cases.write' | 'advertising.campaigns.read' | 'advertising.campaigns.write' | 'advertising.analytics.read' | 'business_directory.profiles.read' | 'business_directory.profiles.write' | 'banks.frontends.read' | 'banks.frontends.write' | 'banks.frontends.publish' | 'banks.eligibility.read' | 'banks.rates.read' | 'banks.products.read' | 'banks.applications.read' | 'banks.applications.write' | 'banks.applications.status.write' | 'banks.documents.read' | 'banks.documents.manifest.write' | 'banks.callbacks.manage' | 'banks.staff.read' | 'banks.staff.manage' | 'banks.audit.read' | 'official_sources.read' | 'official_sources.datasets.read' | 'official_sources.freshness.read' | 'official_sources.audit.read' | 'official_sources.refresh' | 'official_sources.credentials.manage' | 'official_sources.admin' | 'services.bookings.read' | 'services.payments.read' | 'services.payments.write' | 'services.payouts.read' | 'services.payouts.manage' | 'services.payouts.admin' | 'services.settlement.reconcile' | 'platform.billing_owner_visibility.read' | 'platform.import_export_readiness.read' | 'provider_workspace.read' | 'provider_leads.read' | 'provider_leads.manage' | 'provider_bookings.read' | 'provider_bookings.manage' | 'provider_conversations.write' | 'provider_integrations.manage' | 'provider_integrations.sync' | 'provider_catalog.read' | 'provider_sites.read' | 'provider_sites.write' | 'provider_sites.publish' | 'provider_ai.permissions.manage' | 'transactions.read' | 'transactions.write' | 'transactions.documents.read' | 'transactions.documents.write' | 'transactions.milestones.write' | 'conveyancing.matters.read' | 'conveyancing.matters.write' | 'conveyancing.law_firms.manage' | 'conveyancing.audit.read' | 'conveyancing.shares.write' | 'stamp_duty.status.read' | 'stamp_duty.status.write' | 'consents.read' | 'consents.write' | 'document_shares.read' | 'document_shares.write' | 'agent_hosts.read' | 'agent_hosts.write' required

Approved additive platform scope string. Domain scopes are contract-defined for future routes but are not granted to the slice-1 sandbox fixture by default.

required_confirmationstring nullable required
idempotency_requiredboolean required
principalPrincipal required(unresolved $ref)
livemodefalse required
request_idstring required

Changes

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