Skip to main content

ProductCreate

A product is a workspace inside a company. It owns the pipeline (stages), agents, leads, channels and most other entities, and is the unit of access control — most endpoints scope access by product.

nameNamerequired

Human-readable product name.

company_idCompany Idrequired

ID of the owning company (the top-level tenant account).

crm_id object

Identifier of the matching record in the connected external CRM, if any.

anyOf
string
is_activeIs Active

Whether the product is active.

Default value: true
config object

Free-form product-level configuration (JSON).

property name*any

Free-form product-level configuration (JSON).

bot_typeBot Type

Product bot type (e.g. "outreach").

Default value: outreach
ProductCreate
{
  "name": "string",
  "company_id": 0,
  "crm_id": "string",
  "is_active": true,
  "config": {},
  "bot_type": "outreach"
}