Use this when a customer is created or changes in your system.
The following endpoint can be used to add or update a customer within the Hyfin application. The customer mobile phone number and email address will be used to send payment requests to the customer, as described under Who gets notified below.
Each customer is under exactly one notification control, worked out from the site and the customer. It is never stored and cannot be set directly.
On API v4:
The following endpoint can be used to add or update a customer. You must replace the {base_url} and {site_id} variable with the site id that was provided when the site was created.
{
"externalId": "39772634",
"firstName": "John",
"lastName": "Doe",
"accountName": "",
"mobilePhone": "111-222-3333",
"email": "johndoe@abc.com",
"notes": "World's best customer",
"deleted": false
}
{
"success": true,
"action": "added",
"_id": "60f720d248f143332af022e0",
"updatedAt": "2025-05-30T19:19:44.143Z"
}