AddEditRentalOffer
POST
/v2.0/openflow/rental-offer
const url = 'https://wl.api.cluster.openbrix.co.uk/v2.0/openflow/rental-offer';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"flow_id":1,"movein_date":"2026-04-15T12:00:00Z","furnished":"example","rental_amount":1,"tenancy_end_date":"2026-04-15T12:00:00Z","irp_end_date":"2026-04-15T12:00:00Z","rental_due_date":1,"tenancy_start_date":"2026-04-15T12:00:00Z","rental_frequency":"example","is_irp_required":true,"irp_start_date":"2026-04-15T12:00:00Z","common_conditions":"example","number_of_occupants":1,"additional_conditions":"example","tenancy_deposit_amount":1,"tenant_gas_responsibility":true,"initial_rental_amount":1,"tenant_water_responsibility":true,"landlord_bank_account_id":1,"tenancy_deposit_amount_paid":1,"tenant_tv_license_responsibility":true,"tenant_council_tax_responsibility":true,"tenant_electricity_responsibility":true,"open_flow_tenancy_document_scheme_id":1,"tenancy_deposit_amount_remaining":1,"tenant_broadbank_phone_responsibility":true,"is_rental_payment_received_by_landlord":true,"draft_agreement_type":"ast"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://wl.api.cluster.openbrix.co.uk/v2.0/openflow/rental-offer \ --header 'Content-Type: application/json' \ --data '{ "flow_id": 1, "movein_date": "2026-04-15T12:00:00Z", "furnished": "example", "rental_amount": 1, "tenancy_end_date": "2026-04-15T12:00:00Z", "irp_end_date": "2026-04-15T12:00:00Z", "rental_due_date": 1, "tenancy_start_date": "2026-04-15T12:00:00Z", "rental_frequency": "example", "is_irp_required": true, "irp_start_date": "2026-04-15T12:00:00Z", "common_conditions": "example", "number_of_occupants": 1, "additional_conditions": "example", "tenancy_deposit_amount": 1, "tenant_gas_responsibility": true, "initial_rental_amount": 1, "tenant_water_responsibility": true, "landlord_bank_account_id": 1, "tenancy_deposit_amount_paid": 1, "tenant_tv_license_responsibility": true, "tenant_council_tax_responsibility": true, "tenant_electricity_responsibility": true, "open_flow_tenancy_document_scheme_id": 1, "tenancy_deposit_amount_remaining": 1, "tenant_broadbank_phone_responsibility": true, "is_rental_payment_received_by_landlord": true, "draft_agreement_type": "ast" }'Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
flow_id
required
number format: double
movein_date
required
string format: date-time
furnished
required
string
rental_amount
required
number format: double
tenancy_end_date
required
string format: date-time
irp_end_date
required
string format: date-time
rental_due_date
required
number format: double
tenancy_start_date
required
string format: date-time
rental_frequency
required
string
is_irp_required
required
boolean
irp_start_date
required
string format: date-time
common_conditions
required
string
number_of_occupants
required
number format: double
additional_conditions
required
string
tenancy_deposit_amount
required
number format: double
tenant_gas_responsibility
required
boolean
initial_rental_amount
number format: double
tenant_water_responsibility
required
boolean
landlord_bank_account_id
number format: double
tenancy_deposit_amount_paid
number format: double
tenant_tv_license_responsibility
required
boolean
tenant_council_tax_responsibility
required
boolean
tenant_electricity_responsibility
required
boolean
open_flow_tenancy_document_scheme_id
number format: double
tenancy_deposit_amount_remaining
number format: double
tenant_broadbank_phone_responsibility
required
boolean
is_rental_payment_received_by_landlord
required
boolean
draft_agreement_type
required
string
Responses
Section titled “ Responses ”Ok
Media typeapplication/json
object
data
required
status
required
boolean
Examplegenerated
{ "data": "example", "status": true}