Add or Update Contact Extra
Add or Update additional Contact information.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | string | ContactExtraSave | Required |
ContactId | int | The unique identifier of the contact which can be retrieved using Contact List. | Required |
ContactReference | string | The internal reference of the contact. | Required |
ContactExtraCreditLimit | string | Credit limit. | Optional |
ContactExtraCreditLimitCurrency | string | Credit limit currency code. | Optional |
ContactExtraDelay2Pay | string | Delay 2 pay. | Optional |
ContactExtraDirectDebit | bool | Direct debit. | Optional |
ContactExtraAccountReference | string | Account reference. | Optional |
ContactExtraAccountType | int | Account type. | Optional |
ContactExtraLastUpdated | datetime | Last updated date and time. | Optional |
ContactExtraFlaggedReason | string | Flagged reason. | Optional |
ContactExtraFinancialSyncExclude | bool | Exclude from financial sync. | Optional |
ContactExtraUseParentRef | bool | Use parent reference. | Optional |
ContactExtraAccountPackageAccountBalance | decimal | Account balance. | Optional |
ContactExtraAccountPackageAccountStatus | int | Account status. | Optional |
ContactExtraOnStopReason | string | On stop reason. | Optional |
ContactExtraOnStopDate | datetime | On stop date. | Optional |
ContactExtraCreditLimitOnStop | bool | Credit limit on stop. | Optional |
ContactExtraOnStopDescendant | bool | On stop descendant. | Optional |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
0 | Contact {ContactId} {ContactName} has updated successfully | ContactId and ContactName are included in the success message for reference |
2 | Missing parameters. You must include at least a Contact Id or a Contact Reference | Mandatory parameter was not supplied |
2 | When specifying a credit limit the credit limit currency cannot be null. | Ensure a valid currency code is also provided when setting the credit limit |
2 | Invalid Credit Limit. | Double value is invalid or was not specified (when required) |
2 | Invalid Delay2Pay. | Short value is invalid or was not specified (when required) |
2 | Invalid Direct Debit - must be true or false. | Boolean value is invalid or was not specified (when required) |
2 | Invalid Financial Sync Exclude - must be true or false. | Boolean value is invalid or was not specified (when required) |
2 | Invalid Use Parent Ref. | Boolean value is invalid or was not specified (when required) |
2 | Invalid Account Type. | Boolean value is invalid or was not specified (when required) |
2 | Invalid Account Package account balance. | Decimal value is invalid or was not specified (when required) |
2 | Invalid Account Package account status. | Decimal value is invalid or was not specified (when required) |
2 | Invalid On Stop Date. | Date value is invalid or was not specified (when required) |
2 | Invalid Credit Limit on stop - must be true or false. | Boolean value is invalid or was not specified (when required) |
2 | Invalid On stop descendant -must be true or false. | Boolean value is invalid or was not specified (when required) |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=contactupdateref&contactid=39010151&contactref=ABC123456
Response Data
{ "Code": 0, "Result": "Contact 38759340 Joe Bloggs has updated successfully" }