Features - Connectors Framework - Inbound REST API - Prospects
Add Note to Prospect
Overview
Add a note to a Prospect in MobiWork
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/prospect/{prospectId}/note/add.html?token=XXXXXXXX&userId={userId}
Arguments
clientId
required
MobiWork assigned unique ID of the company
versionNumber
required
Version number of MobiWork API SDK release. Current version is: 10.0.78
token
required
Part of URL as a request parameter and is required in every call to verify access to API calls
prospectId
required
The identifier of the prospect to be updated
userId
optional
If provided, this User ID will be taken as a logged in user. If not provided we use an active global administrator ID
Return
Returns a note added success message if valid arguments are provided. Returns an error if not a valid request
Request Body XSD
Response Body XSD
Curl Example
HTTP Method: GET
Request: curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/prospect/3199007/note/add.html?token=COJL8X2FKSLMMRTYCH2B" -data '<request> <description>Testing: new note to wo thru api</description> <visibleToprospect>false</visibleToprospect> </request>'
Response: <?xml version="1.0" encoding="UTF-8" ?><response version="5.0.61" statusCode="1">Note added to prospect (3199007) successfully</response>