Vendors: put

Update a Vendor.

Request - POST https://api-uat.vtopenview.com/vendors/{vendorid}

You will need to supply a request body and supply the Vendor 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//vendors/{vendorid}
--header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Request Body
Example request body:

Content-Type: application/json
{
"vendorid": long,
"title": "string",
"forename": "string",
"surname": "string",
"companyname": "string",
"website": "string",
"phone": "string",
"workphone": "string",
"mobilephone": "string",
"email": "string",
"salutation": "string",
"source": "string",
"internalreference": "string",
"negotiator": {
"userid": long,
"name": "string",
"email": "string"
},
"branch": {
"branchid": integer,
"branchname": "string"
},
"status": "string",
"notes": "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 vendors. This field is optional.

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

Example field on request:

"source": "Walk In"

Status:

The list below describes the possible status for vendors. 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"

Response

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

Example response:

HTTPS 200 OK
Content-Type: application/json
{
"vendorid": long,
"title": "string",
"forename": "string",
"surname": "string",
"companyname": "string",
"website": "string",
"phone": "string",
"workphone": "string",
"mobilephone": "string",
"email": "string",
"salutation": "string",
"source": "string",
"internalreference": "string",
"negotiator": {
"userid": long,
"name": "string",
"email": "string"
},
"branch": {
"branchid": integer,
"branchname": "string"
},
"status": "string",
"notes": "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"
},
}