UpdateRentReadySettings
POST
/v2.0/rent_ready/profile
const url = 'https://wl.api.cluster.openbrix.co.uk/v2.0/rent_ready/profile';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"is_tenant_info_shared":true,"is_right_to_rent_shared":true,"is_affordability_shared":true,"is_pre_reference_shared":true,"is_rental_ledger_shared":true,"is_id_verification_shared":true,"is_guarantor_affordability_shared":true,"default_documents_shared":[1]}'};
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/rent_ready/profile \ --header 'Content-Type: application/json' \ --data '{ "is_tenant_info_shared": true, "is_right_to_rent_shared": true, "is_affordability_shared": true, "is_pre_reference_shared": true, "is_rental_ledger_shared": true, "is_id_verification_shared": true, "is_guarantor_affordability_shared": true, "default_documents_shared": [ 1 ] }'Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
is_tenant_info_shared
required
boolean
is_right_to_rent_shared
required
boolean
is_affordability_shared
required
boolean
is_pre_reference_shared
required
boolean
is_rental_ledger_shared
required
boolean
is_id_verification_shared
required
boolean
is_guarantor_affordability_shared
required
boolean
default_documents_shared
Array<number>
Examplegenerated
{ "is_tenant_info_shared": true, "is_right_to_rent_shared": true, "is_affordability_shared": true, "is_pre_reference_shared": true, "is_rental_ledger_shared": true, "is_id_verification_shared": true, "is_guarantor_affordability_shared": true, "default_documents_shared": [ 1 ]}Responses
Section titled “ Responses ”Ok
Media typeapplication/json
object
data
required
status
required
boolean
Examplegenerated
{ "data": "example", "status": true}