online-help.platform.features.premier_subscription.connectors.inbound-rest-api.endpoints.prospect.title
Add Prospect
Overview
Creates a Prospect in MobiWork
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/prospect/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
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 Prospect Object if prospect creation is successful or errors will be returned
Request Body XSD
Response Body XSD
Curl Example
HTTP Method: POST
Request: curl -k -X POST -H "https://www.mobiwork.com/api/rest/12014/10.0.78/prospect/add.html?token=COJL8X2FKSLMMRTYCH2B" -data '<request>
<prospect>
<name>Test Prospect</name>
<firstName>Prospect First Name</firstName>
<lastName>Prospect Last Name</lastName>
<email>jdoe@gmail.com</email>
<phone>12345678901</phone>
</prospect>
</request>
'
Response: <?xml version="1.0" encoding="UTF-8" ?>
<response version="5.0.156" statusCode="1">
<prospect>
<entityId>1223587</entityId>
<name>Test Prospect</name>
<createdDate>09/17/2018 14:30:42</createdDate>
<prospectId>1223587</prospectId>
<firstName>Prospect First Name</firstName>
<lastName>Prospect Last Name</lastName>
<email>jdoe@gmail.com</email>
</prospect>
</response>