PATCH
/api/public/v1/settings/company

Update company settings

Update display name, automated tax flag, IP whitelist enforcement, etc.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Dev Tools → API, to an assistant or CLI sign-in when you approve or edit it under Dev Tools, and to a teammate under Employee → Permissions.

settings:write

Request Body

PropertyTypeDescription
displayNamestringCompany display name.
ipWhitelistEnabledbooleanEnforce IP whitelist.
automatedTaxesbooleanEnable automated taxes.
PATCHExample request
curl
curl -X PATCH "https://www.pxb.app/api/public/v1/settings/company" \
  -H "Authorization: Bearer your_access_token" \
  -H "Content-Type: application/json" \
  -d '{
    "ipWhitelistEnabled": true
  }'
200Example response
json
{
  "message": "Company settings updated successfully!",
  "content": {
    "settings": {
      "ipWhitelistEnabled": true
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Settings → Company → General
/settings/company/general
  1. Edit the company details and save.