/customer/update
Update customer record.
Parameters
| Name |
Type |
Required |
Example |
Description |
| clientId |
string(40) |
yes |
04f78...9f9f3 |
Client id is a unique user identifier provided by GatherUp. |
| customerEmail |
string(email) |
no |
john.smith@app.gatherup.com |
Customer email address. |
| customerFirstName |
string |
no |
John |
Customer first name. |
| customerId |
integer |
yes |
1 |
Customer id. |
| customerLastName |
string |
no |
Smith |
Customer last name. |
| customerPhoneNumber |
string |
no |
555 5555 5555 |
Customer mobile phone number. |
| customerPreference |
string(sms|email) |
no |
email |
Customer communication preference. |
| customerCustomId |
integer |
no |
2 |
Customer custom id. |
| customerJobId |
integer |
no |
10 |
Customer job id. |
| customerTags |
string |
no |
Auto, Towing, Roadside Service |
Overwrites / Removes existing Customer tags with the new tags specified. Add tags comma separated. |
| hash |
string(64) |
yes |
bd13a40...303f3c5 |
Hash is a digital request signature. Learn how to generate hash here. |
Request
POST https://app.gatherup.com/api/customer/update
[Content-Type: application/json]
{
"customerId": 1,
"clientId": "04f78076fbfc66940169d2199af7c6698019f9f3",
"customerEmail": "john.smith@abc-company.com",
"customerFirstName": "John",
"customerLastName": "Smith",
"customerCustomId": 2,
"customerJobId": 10,
"customerTags": "Auto, Towing, Roadside Service",
"hash": "67fbca027648a3caf08e47ca685d772aa2d92fb526b8b6e91d74286301c99988",
}
Response
{
"errorCode": 0,
"errorMessage": "Success"
}
Errors
| errorCode |
errorMessage |
| -1 |
Unknown error |
| 1 |
Invalid hash sign |
| 2 |
Invalid clientId |
| 5 |
This user cannot manage selected business |
| 6 |
Invalid businessId |
| 7 |
Invalid customer first name |
| 8 |
Invalid customer last name |
| 9 |
Invalid customer email |
| 44 |
Customer not found |
| 47 |
You can not update feedback history record |
| 48 |
Customer with this email already exists |