Skip to main content
PATCH
Update the business and owner details of an end user

Authorizations

x-api-key
string
header
required

Path Parameters

end_user_heron_id
string
required

The Heron ID of the end user

Body

application/json

Updates the business and owner details. Fields you do not send stay as they are. To remove a value you set, send null. The response is the same as GET /end_users/{id}/details.

business
object | null

Business details to update.

owners
object[]

Owners to update or add. Use heron_id to update an existing owner. Leave it out to add a new one.

Response

OK

The business and its owners, with one value per field.

business
object | null
required

The applicant's business.

custom_entities
object
required

Your custom fields, grouped by entity name. Each entity has its values and a _sources object with the source of each value.

owners
object[]
required

The business owners. Owners named by more sources come first, then the largest ownership percentage, then the order on the application.