Features - Connectors Framework - Inbound REST API - Customers
Edit Customer
Overview
Updating Customer info in MobiWork
URL Format
https://{domain}.mobiwork.com/api/rest/{clientId}/{versionNumber}/customer/{customerId}/edit.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
customerId
required
The identifier of the customer to be retrieved
Return
Returns a Customer Object if customer update 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/customer/501268/edit.html?token=COJL8X2FKSLMMRTYCH2B" -data '<request>
<customer>
<companyName>APITEST Company2</companyName>
<type>BUSINESS</type>
<status>0</status>
<externalId>APIC1112</externalId>
<customStatus>Lead</customStatus>
<address>
<address1>160 Congress Park Dr</address1>
<address2>Ste 205</address2>
<city>Delray Beach</city>
<state>FL</state>
<zipCode>33445</zipCode>
<countryId>1</countryId>
<name>Primary Address</name>
</address>
<primaryContact>
<firstName>John</firstName>
<lastName>Doe</lastName>
<title/>
<email>jdoe@gmail.com</email>
<phoneNumber>561111115</phoneNumber>
<altPhoneNumber/>
<phoneExt/>
<altPhoneExt/>
<fax/>
</primaryContact>
<assignedTo>0</assignedTo>
<customFields>
<customField>
<apiName>ServiceContract</apiName>
<index>0</index>
<value>false</value>
</customField>
<customField>
<apiName>ReqField</apiName>
<index>0</index>
<value>TTTTTT2</value>
</customField> </customFields> </customer> </request>'
Response: <?xml encoding="UTF-8" ?>
<response version="10.0.78" statusCode="1">
<customer>
<mobiworkCustomerId>501268</mobiworkCustomerId>
<externalCustomerId>APIC1112</externalCustomerId>
<companyName>APITEST Company2</companyName>
<typeId>BUSINESS</typeId>
<statusId>589</statusId>
<enabled>true</enabled>
<address>
<addressId>818637</addressId>
<address1>160 Congress Park Dr</address1>
<address2>Ste 205</address2>
<city>Delray Beach</city>
<state>FL</state>
<zipCode></zipCode>
<countryId>0</countryId>
<latitude>26.4582132</latitude>
<longitude>-80.0940502</longitude>
<name></name>
<baseDistance>9022407</baseDistance>
</address>
<contact>
<contactId>685035</contactId>
<customerId>501268</customerId>
<firstName>John</firstName>
<lastName>Doe</lastName>
<title></title>
<email>jdoe@gmail.com</email>
<phoneNumber>561111115</phoneNumber>
<altPhoneNumber></altPhoneNumber>
<phoneExt></phoneExt>
<altPhoneExt></altPhoneExt>
<pin>4790</pin>
<enabled>true</enabled>
<createdDate>Tue Oct 18 16:22:22 EDT 2016</createdDate>
<fax></fax>
<admin>true</admin>
<employeeId></employeeId>
<loginId></loginId>
<password></password>
</contact>
</customer>
</response>