Landlords: put

Update a Landlord.

Request - PUT https://api-uat.vtopenview.com/landlords/{landlordid}

You will need to supply a request body and supply the Landlord Id on your request parameters with this method.
You will need to include your access token upon making a request. For more information, see the authentication and authorization page.

Example request with authorization:

curl -- PUT Base URI: https://api-uat.vtopenview.com/landlords/{landlordid}
--header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Request Body
Example request body:

Content-Type: application/json
{
"landlordid": long,
"title": "string",
"forename": "string",
"surname": "string",
"companyname": "string",
"website": "string",
"phone": "string",
"workphone": "string",
"mobilephone": "string",
"email": "string",
"salutation": "string",
"agreementname": "string",
"source": "string",
"lettingsreason": "string",
"internalreference": "string",
"negotiator": {
"userid": long,
"name": "string",
"email": "string"
},
"branch": {
"branchid": integer,
"branchname": "string"
},
"status": "string",
"overseas": "string",
"taxenabled": "string",
"excludefrompayments": boolean,
"registrationnumber": "string",
"cnrnumber": "string",
"cnrapprovaldate": "string",
"taxrate": decimal,
"vatregistration": "string",
"hmrcduedate": "date",
"statement": "string",
"sendstatementvia": "string",
"safedepositstype": "string",
"safedepositsregnumber": "string",
"financialnotes": "string",
"address": {
"houseno": "string",
"address1": "string",
"address2": "string",
"town": "string",
"county": "string",
"postcode": "string",
"latitude": decimal,
"longitude": decimal,
"geocodingverified": boolean,
"countryname": "string",
"countrydisplayname": "string",
"fulladdress": "string",
"shortaddress": "string"
}
}

Source Types:

The list below describes the possible sources types for landlords. This field is optional.

Walk In
Friend
Recommendation
Website
Rightmove
Zoopla
On The Market
Prime Location

Example field on request:

"source": "Walk In"

Status:

The list below describes the possible status for landlords. This field is required.
If your company has set up other statuses on OpenView, please verify the string you are sending.

Active
Prospective
Archived

Example field on request:

"status": "Active"

Statement:

The list below describes the possible statements types for landlords. This field is optional.

Landlord Statement
Consolidated Statement
Grouped Consolidated Statement
Portfolio Statement
Advanced Landlord Statement

Example field on request:

"statement": "Consolidated Statement"

Send Statement Via:

The list below describes the possible send statements via types for landlords. This field is optional.

Letter
Email

Example field on request:

"sendstatementvia": "Email"

Safe Deposits Type:

The list below describes the possible safe deposits types for landlords. This field is optional.

Registered
Applied
Appealing
Not Registered

Example field on request:

"safedepositstype": "Registered"

Response

If successful, this method returns a response body with the following structure:

Example response:

HTTPS 200 OK
Content-Type: application/json
{
"landlordid": long,
"title": "string",
"forename": "string",
"surname": "string",
"companyname": "string",
"website": "string",
"phone": "string",
"workphone": "string",
"mobilephone": "string",
"email": "string",
"salutation": "string",
"agreementname": "string",
"source": "string",
"lettingsreason": "string",
"internalreference": "string",
"negotiator": {
"userid": long,
"name": "string",
"email": "string"
},
"branch": {
"branchid": integer,
"branchname": "string"
},
"status": "string",
"overseas": "string",
"taxenabled": "string",
"excludefrompayments": boolean,
"registrationnumber": "string",
"cnrnumber": "string",
"cnrapprovaldate": "string",
"taxrate": decimal,
"vatregistration": "string",
"hmrcduedate": "date",
"statement": "string",
"sendstatementvia": "string",
"safedepositstype": "string",
"safedepositsregnumber": "string",
"financialnotes": "string",
"address": {
"houseno": "string",
"address1": "string",
"address2": "string",
"town": "string",
"county": "string",
"postcode": "string",
"latitude": decimal,
"longitude": decimal,
"geocodingverified": boolean,
"countryname": "string",
"countrydisplayname": "string",
"fulladdress": "string",
"shortaddress": "string"
}
}