Applicants: post

Create a new Applicant.

Request - POST https://api-uat.vtopenview.com/applicants

You will need to supply a request body 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 -- POST Base URI: https://api-uat.vtopenview.com/applicants --header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Request Body

Example request body:

Content-Type: application/json { "lettings": boolean, "sales": boolean, "title": "string", "forename": "string", "surname": "string", "companyname": "string", "website": "string", "phone": "string", "workphone": "string", "mobilephone": "string", "email": "string", "salutation": "string", "source": "string", "temperature": "string", "internalreference": "string", "negotiator": { "userid": long, "name": "string", "email": "string" }, "branch": { "branchid": integer, "branchname": "string" }, "status": "string", "contactnotes": "string", "additionalinformation": "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" }, "criteria": { "areas": [ { "area": "string", "miles": decimal, } ], "minprice": decimal, "maxprice": decimal, "bedrooms": integer, "bathrooms": integer, "moveindate": "date", "buyerposition": "string", "propertyattributes": [ { "attribute": "string", } ], "propertystyle": [ { "style": "string", } ], "udf": [ { "udfid": long, "value": "string" } ] }

Source Types:

The list below describes the possible sources types for applicants. 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 applicants. This field is required.
If your company has set up other statuses on OpenView, please verify the string you are sending.

Active
Inactive
Archived

Example field on request:

"status": "Active"

Temperature:

The list below describes the possible temperatures types for applicants. This field is optional.

Cold
Hot
Warm

Example field on request:

"temperature": "Hot"

Buyer Position:

The list below describes the possible buyer positions types for applicants. This field is optional and it's only available for Sales Applicants.
If your company has set up other buyer positions types on OpenView, please verify the string you are sending.

Cash Buyer
First Time Buyer

Example field on request:

"buyerposition": "First Time Buyer"

Response

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

Example response:

HTTPS 200 OK Content-Type: application/json { "applicantid": long, "lettings": boolean, "sales": boolean, "title": "string", "forename": "string", "surname": "string", "companyname": "string", "website": "string", "phone": "string", "workphone": "string", "mobilephone": "string", "email": "string", "salutation": "string", "source": "string", "temperature": "string", "internalreference": "string", "negotiator": { "userid": long, "name": "string", "email": "string" }, "branch": { "branchid": integer, "branchname": "string" }, "status": "string", "contactnotes": "string", "additionalinformation": "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" }, "criteria": { "areas": [ { "area": "string", "miles": decimal, } ], "minprice": decimal, "maxprice": decimal, "bedrooms": integer, "bathrooms": integer, "moveindate": "date", "buyerposition": "string", "propertyattributes": [ { "attribute": "string", } ], "propertystyle": [ { "style": "string", } ], "udf": [ { "udfid": long, "value": "string" } ] }