Skip to main content
PATCH
/
v1
/
businesses
/
{businessId}
Update business
curl --request PATCH \
  --url https://api.halth.com/v1/businesses/{businessId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "locations": [
    "<string>"
  ],
  "name": "<string>",
  "taxIdentifier": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "settings": {
    "autoReconciliationEnabled": true,
    "autoInviteClientsEnabled": true
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "taxIdentifier": "<string>",
  "countryCode": "<string>",
  "merchantId": "<string>",
  "capabilities": [
    {}
  ],
  "events": {}
}

Path Parameters

​
businessId
string
required

Body

application/json
​
locations
string[]
Required array length: 1 - 100 elements
​
name
string
​
taxIdentifier
string
​
structure
enum<string>
Available options:
public_corporation,
private_corporation,
sole_proprietorship,
private_partnership,
trust,
incorporated_non_profit,
unincorporated_association

Response

200 - application/json
​
id
string
required
​
name
string
required
​
settings
object
required
​
createdAt
string<date-time>
required
​
taxIdentifier
string
​
countryCode
string
​
structure
enum<string>
Available options:
public_corporation,
private_corporation,
sole_proprietorship,
private_partnership,
trust,
incorporated_non_profit,
unincorporated_association
​
merchantId
string
​
capabilities
object[]
​
events
object