Business API reference

View business profile

business.get_profileread

Read the account's customer-facing business identity (name, logo, contact details, address and tax ID), IANA timezone, display currency, and weekly opening hours. These identity fields appear on invoices. `currency` is what was explicitly set and may be null; `effective_currency` is what the account is actually shown in after falling back to the country and then to usd. Read-only; changes nothing.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/business.get_profile \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Test with your API key

Over MCP the same operation is the tool business_get_profile at https://app.chirply.io/api/mcp, same bearer token, same input.

Save business settings

business.update_profilewriteadmin only

Update the account's business identity used on invoices, hosted logo URL, IANA timezone, display currency, or weekly opening hours. Changing the timezone immediately changes which local calendar day timestamped revenue and activity appear under; it does not alter payment timestamps or money. Changing the currency changes how amounts are LABELLED from then on — it converts nothing, re-prices nothing, and leaves the currency stored on existing deals, invoices and payments exactly as it is.

Parameters

Field	Type	Required	Description
name	string	optional	Business name shown throughout the account.
logo_url	string (uri) (or null)	optional	Public HTTPS URL for the business logo, or null to remove it.
email	string (email) (or null)	optional	Customer-facing business email printed on invoices.
phone	string (or null)	optional	Customer-facing business phone printed on invoices.
website	string (uri) (or null)	optional	Customer-facing HTTPS website printed on invoices.
address_line_1	string (or null)	optional	First line of the business address printed on invoices.
address_line_2	string (or null)	optional	Optional second line of the business address.
city	string (or null)	optional	Business address city.
state	string (or null)	optional	Business address state, province, or region.
postal_code	string (or null)	optional	Business address postal code.
country	string (or null)	optional	Business address country.
currency	string (or null)	optional	Three-letter ISO-4217 currency the account's deals, invoices and forecasts are displayed in, such as gbp. Null means derive it from the country. Display only — nothing is converted and amounts already recorded keep the currency they were written with.
tax_id	string (or null)	optional	Tax or business registration identifier printed on invoices.
timezone	string	optional	IANA timezone that defines the account's local day, such as America/Chicago.
hours	object	optional	Complete seven-day business-hours schedule in the selected timezone.
hours.mon	object	required	Monday's hours.
hours.mon.enabled	boolean	required	Whether the business is open on this day.
hours.mon.start	string	required	Opening time in 24-hour local HH:MM format.
hours.mon.end	string	required	Closing time in 24-hour local HH:MM format.
hours.tue	object	required	Tuesday's hours.
hours.tue.enabled	boolean	required	Whether the business is open on this day.
hours.tue.start	string	required	Opening time in 24-hour local HH:MM format.
hours.tue.end	string	required	Closing time in 24-hour local HH:MM format.
hours.wed	object	required	Wednesday's hours.
hours.wed.enabled	boolean	required	Whether the business is open on this day.
hours.wed.start	string	required	Opening time in 24-hour local HH:MM format.
hours.wed.end	string	required	Closing time in 24-hour local HH:MM format.
hours.thu	object	required	Thursday's hours.
hours.thu.enabled	boolean	required	Whether the business is open on this day.
hours.thu.start	string	required	Opening time in 24-hour local HH:MM format.
hours.thu.end	string	required	Closing time in 24-hour local HH:MM format.
hours.fri	object	required	Friday's hours.
hours.fri.enabled	boolean	required	Whether the business is open on this day.
hours.fri.start	string	required	Opening time in 24-hour local HH:MM format.
hours.fri.end	string	required	Closing time in 24-hour local HH:MM format.
hours.sat	object	required	Saturday's hours.
hours.sat.enabled	boolean	required	Whether the business is open on this day.
hours.sat.start	string	required	Opening time in 24-hour local HH:MM format.
hours.sat.end	string	required	Closing time in 24-hour local HH:MM format.
hours.sun	object	required	Sunday's hours.
hours.sun.enabled	boolean	required	Whether the business is open on this day.
hours.sun.start	string	required	Opening time in 24-hour local HH:MM format.
hours.sun.end	string	required	Closing time in 24-hour local HH:MM format.

Example

curl -X POST https://app.chirply.io/api/v1/actions/business.update_profile \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example",
    "logo_url": "https://example.com"
  }'

Test with your API key

Over MCP the same operation is the tool business_update_profile at https://app.chirply.io/api/mcp, same bearer token, same input.