[PUT] - Update Watchlist{Deprecated}

Follow

Use the Update Watchlist endpoint to update a watchlist for an InsideView Sales user.

Note: In order to be able to use this API, you will need:

  • a special API key, linked to your InsideView for Sales account
  • InsideView for Sales admin privileges to generate an "admin" consent to access user data through the API.

See Authentication and Authorization Overview for more details.

Endpoint

PUT https://api.insideview.com/api/v1/insighs/watchlist/{watchlistId}

Request

HTTP Headers

Header Name Type Required Description
accessToken String Yes Valid access token with code grant.
See Authentication and Authorization Overview for more details.
Accept String No Selects the response's content type.  
Valid values are application/json and application/xml (default).  

URI Parameters

Parameter Name Type Required Description
watchlistId String Yes Id of the watchlist to update

Form Parameters

Parameter Name Type Required Description
userEmail String Yes Email address of the InsideView Sales user you want to update a watchlist for.
The email address should match the one registered in InsideView Sales application for the user.
name String No Updated name of the watchlist
removeCompanyIds String No Comma separated list of InsideView company ids to remove from the watchlist.
removeContactIds String No Comma separated list of InsideView contact ids to remove from the watchlist.
addCompanyIds String No Comma separated list of InsideView company ids to add to the watchlist.
addContactIds String No Comma separated list of InsideView contact ids to add to the watchlist.

Responses

HTTP 200

Returns either a JSON or XML data structure depending on the request Accept header. 

Name type Description
watchlistId String Id of the new watchlist
name String Watchlist name
companyIds Array Array of company ids
contactIds Array Array of contact ids
operation String Fixed value: "WATCHLIST_UPDATED"

application/json example

{
"watchListId":"2670675",
"name":"My WatchList",
"companyIds":[
"736233"
],
"contactIds":[
"3"
],
"operation":"WATCHLIST_UPDATED"
}

application/xml example

<?xml version="1.0" encoding="UTF-8"?>

HTTP 400

Invalid query parameter(s).

HTTP 401

Unauthorized Error - Cannot use API's without setting a valid accessToken in header.

HTTP 405

Method Not Allowed - Your are not allowed to access this API.

HTTP 404

Invalid ID, record not found.

HTTP 429

Request is throttled.

 

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk