JiwaAPI

<back to all web services

DebtorWebContactPATCHRequest

Requires Authentication
The following routes are available for this service:
PATCH/Debtors/{DebtorID}/WebContacts/{ContactNameID}Updates a debtor contact and/or its web properties.
DebtorWebContactPATCHRequest Parameters:
NameParameterData TypeRequiredDescription
DebtorIDpathstringNo
ContactNameIDpathstringNo
WebContactWriteBody Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
FirstNameformstringNo
SurnameformstringNo
EmailAddressformstringNo
PhoneformstringNo
MobileformstringNo
FaxformstringNo
DefaultContactformbool?No
PrimaryPositionIDformstringNo
PrimaryPositionNameformstringNo
WebUserIdformstringNo
WebPermissionsformstringNo
EmailMarketingformstringNo
WebContact Parameters:
NameParameterData TypeRequiredDescription
DebtorIDformstringNo
AccountNoformstringNo
DebtorNameformstringNo
ContactNameIDformstringNo
TitleformstringNo
FirstNameformstringNo
SurnameformstringNo
EmailAddressformstringNo
PhoneformstringNo
MobileformstringNo
DefaultContactformbool?No
PrimaryPositionIDformstringNo
WebUserIdformstringNo
WebPermissionsformstringNo
EmailMarketingformstringNo
ContactLastSavedDateTimeformDateTime?No
WebLastSavedDateTimeformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /Debtors/{DebtorID}/WebContacts/{ContactNameID} HTTP/1.1 
Host: 10.150.151.12 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DebtorID":"String","ContactNameID":"String","Title":"String","FirstName":"String","Surname":"String","EmailAddress":"String","Phone":"String","Mobile":"String","Fax":"String","DefaultContact":false,"PrimaryPositionID":"String","PrimaryPositionName":"String","WebUserId":"String","WebPermissions":"String","EmailMarketing":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DebtorID":"String","AccountNo":"String","DebtorName":"String","ContactNameID":"String","Title":"String","FirstName":"String","Surname":"String","EmailAddress":"String","Phone":"String","Mobile":"String","DefaultContact":false,"PrimaryPositionID":"String","WebUserId":"String","WebPermissions":"String","EmailMarketing":"String","ContactLastSavedDateTime":"0001-01-01T00:00:00.0000000","WebLastSavedDateTime":"0001-01-01T00:00:00.0000000"}