/business/notifications/email/add
Add an email to the notifications system.
Parameters
| Name |
Type |
Required |
Example |
Description |
| businessId |
integer |
yes |
6418 |
Business id. |
| clientId |
string(40) |
yes |
04f78...9f9f3 |
Client id is a unique user identifier provided by GatherUp. |
| email |
string |
yes |
customer-name@app.gatherup.com |
Email address. |
| hash |
string(64) |
yes |
bd13a40...303f3c5 |
Hash is a digital request signature. Learn how to generate hash here. |
| type |
string(all, first-party, third-party, reports, all-feedback-sent, qna) |
yes |
all |
Notification type. |
Request
POST https://app.gatherup.com/api/business/notifications/email/add
[Content-Type: application/json]
{
"businessId": 6418,
"email": "customer-name@app.gatherup.com",
"clientId": "627d5e234e1a2f503c9e12262cf313d693575895",
"hash": "b98340caf25c00be59f5bb5405ca8f358edf22c15a4f8527785af047e541f857",
"type": "all"
}
Response
{
"errorCode": 0,
"errorMessage": "Success"
}
Errors
| errorCode |
errorMessage |
| -1 |
Unknown error |
| 1 |
Invalid hash sign |
| 2 |
Invalid clientId |
| 3 |
Server error - please contact support |
| 5 |
This user cannot manage selected business |
| 25 |
Business does not exist |
| 35 |
Notification type does not exist |
| 36 |
Invalid email |