Companies

5 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

Create a company

companies.createwrite

Create a company record. Only a name is required; attach contacts to it afterwards with contacts.update.

Parameters

Field	Type	Required	Description
name	string	required	The company name.
domain	string	optional	Primary domain, e.g. 'acme.com'.
phone	string	optional	Main phone number.
website	string	optional	Website URL.
industry	string	optional	Industry.
owner_id	string (uuid)	optional	User id of the team member who owns the relationship.
address	object	optional	Postal address with separate street, city, state, and ZIP / postal code fields.
address.line1	string	optional	Street address.
address.line2	string	optional	Suite / unit.
address.city	string	optional	City.
address.state	string	optional	State or province.
address.postal_code	string	optional	ZIP / postal code.
address.country	string	optional	Country.
notes	string	optional	Free-text notes on the record, visible to the whole account.
custom	map of string → object	optional	Custom-field values keyed by `custom_field_defs.key` (see contacts.list_fields). Replaces the whole blob — send the merged object.

Example

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

Test with your API key

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

Delete a company

companies.deletewriteconfirm

Permanently delete a company and its activity timeline. Contacts at the company are kept but are detached from it. This cannot be undone.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Field	Type	Required	Description
id	string (uuid)	required	The company to delete.

Example

curl -X POST https://app.chirply.io/api/v1/actions/companies.delete \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

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

Open a company

companies.getread

Fetch one company by id, with all of its fields. Use contacts.list with company_id for the people who work there.

Parameters

Field	Type	Required	Description
id	string (uuid)	required	The company's id.

Example

curl -X POST https://app.chirply.io/api/v1/actions/companies.get \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

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

List companies

companies.listread

List the organization's companies, A–Z. Search matches the company name.

Parameters

Field	Type	Required	Description
limit	integer	optional	Max rows to return (1–100). Default: 25
offset	integer	optional	Rows to skip. Default: 0
query	string	optional	Text to match in the company name.
owner_id	string (uuid)	optional	Only companies owned by this user.

Example

curl -X POST https://app.chirply.io/api/v1/actions/companies.list \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Test with your API key

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

Edit a company

companies.updatewrite

Update fields on an existing company. Omitted fields are left alone; an explicit null clears one.

Parameters

Field	Type	Required	Description
id	string (uuid)	required	The company to edit.
name	string	optional	The company name.
domain	string (or null)	optional	Primary domain, e.g. 'acme.com'.
phone	string (or null)	optional	Main phone number.
website	string (or null)	optional	Website URL.
industry	string (or null)	optional	Industry.
owner_id	string (uuid) (or null)	optional	User id of the team member who owns the relationship.
address	object (or null)	optional	Postal address with separate street, city, state, and ZIP / postal code fields.
address.line1	string	optional	Street address.
address.line2	string	optional	Suite / unit.
address.city	string	optional	City.
address.state	string	optional	State or province.
address.postal_code	string	optional	ZIP / postal code.
address.country	string	optional	Country.
notes	string (or null)	optional	Free-text notes on the record, visible to the whole account.
custom	map of string → object	optional	Custom-field values keyed by `custom_field_defs.key` (see contacts.list_fields). Replaces the whole blob — send the merged object.

Example

curl -X POST https://app.chirply.io/api/v1/actions/companies.update \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

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