Products

List the CRM products (the catalog deal quotes are built from)

crm.products.list

Lists the org's manually curated products (the ones deal quotes are built from) in the same manual order as the settings screen, paginated by cursor (limit up to 200). Archived products are left out unless include_archived is true (the page is filled skipping them). Each product says who created it (created_by_name). Each product carries its default price, currency, billing frequency (one_time or monthly), tax, SKU and custom fields. Synced feed catalogs are a different thing: see crm.catalogs.list.

Scope

crm:read

Permission

View the module

MCP tool

crm_products_listOn the full surface; on the compact one, mb_execute_operation with id: "crm.products.list".

Declared cost: up to 202 reads and 0 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl "https://api.mb-suite.com/v1/crm/products" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/crm/products" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Get one CRM product

crm.products.get

Returns one product of the org's product list (name, default price, currency, frequency, tax, description, SKU, image, custom fields, archived flag and order). Not found if the id does not exist. Use crm.products.list when you do not know the id.

Scope

crm:read

Permission

View the module

MCP tool

crm_products_getOn the full surface; on the compact one, mb_execute_operation with id: "crm.products.get".

Declared cost: up to 1 reads and 0 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl "https://api.mb-suite.com/v1/crm/products/{product_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl "https://api.mb-suite.com/v1/crm/products/{product_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Create a CRM product

crm.products.create

Adds a product at the end of the org's product list with a name and, optionally, default price (0 if omitted), currency (ISO code; without it the workspace's main currency applies), frequency (one_time by default, or monthly), tax percentage, description, SKU, image URL and up to 50 custom fields. Deal quotes copy these values when a line is added; editing the product later does not change existing quotes. Requires manage_products (owners, admins and CRM admins).

Scope

crm:write

Permission

Edit in the module · CRM action: manage_products

MCP tool

crm_products_createOn the full surface; on the compact one, mb_execute_operation with id: "crm.products.create".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/crm/products" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME"
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/crm/products" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "name": "NAME"
}'

Update a CRM product

crm.products.update

Updates one or more fields of a product: name, default price, currency, frequency, tax, description, SKU, image URL or custom fields. Pass null on currency, tax, description, sku, image_url or custom_fields to clear them. Existing deal quotes keep the values they copied. Fails with no_changes if nothing is sent. Requires manage_products.

Scope

crm:write

Permission

Edit in the module · CRM action: manage_products

MCP tool

crm_products_updateOn the full surface; on the compact one, mb_execute_operation with id: "crm.products.update".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X PATCH "https://api.mb-suite.com/v1/crm/products/{product_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X PATCH "https://api.mb-suite.com/v1/crm/products/{product_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Reorder the CRM product list

crm.products.reorder

Sets the manual order of the product list: each id in ordered_ids gets its position as order (up to 2000 ids, usually the full list as shown). An id that does not exist fails with product_not_found. Not audited, like every reorder. Requires manage_products.

Scope

crm:write

Permission

Edit in the module · CRM action: manage_products

MCP tool

crm_products_reorderOn the full surface; on the compact one, mb_execute_operation with id: "crm.products.reorder".

Declared cost: up to 0 reads and 2000 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/crm/products/reorder" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "ordered_ids": [
    "ORDERED_ID"
  ]
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/crm/products/reorder" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "ordered_ids": [
    "ORDERED_ID"
  ]
}'

Archive or unarchive a CRM product

crm.products.archive

Archives (is_archived: true) or unarchives (false) a product. An archived product stays referenceable by existing quotes but is hidden from the product picker and from crm.products.list unless include_archived is set. This is NOT the trash (see crm.products.delete). Requires manage_products.

Scope

crm:write

Permission

Edit in the module · CRM action: manage_products

MCP tool

crm_products_archiveOn the full surface; on the compact one, mb_execute_operation with id: "crm.products.archive".

Declared cost: up to 1 reads and 1 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/crm/products/{product_id}/archive" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "is_archived": true
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/crm/products/{product_id}/archive" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "is_archived": true
}'

Delete a CRM product

crm.products.delete

Deletes a product from the org's list. It goes to the 30-day trash: restore it with platform.trash.restore (or from CRM settings → Trash); deal quotes that used it keep their own copy of the line. Prefer crm.products.archive when it should just stop being offered. Requires manage_products.

With an API key, this DELETE runs directly: the record stays 30 days in the trash and the response carries its trash_item_id. With an OAuth token, and through the MCP, it needs dry_run → confirm_token.

Scope

crm:write and “Allow deletions” (crm:delete in OAuth)

Permission

Edit in the module · CRM action: manage_products

MCP tool

crm_products_deleteOn the full surface; on the compact one, mb_execute_operation with id: "crm.products.delete".

Declared cost: up to 1 reads and 2 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X DELETE "https://api.mb-suite.com/v1/crm/products/{product_id}" \
  -H "Authorization: Bearer $MB_API_KEY"

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X DELETE "https://api.mb-suite.com/v1/crm/products/{product_id}" \
  -H "Authorization: Bearer $MB_TEST_KEY"

Archive or unarchive many CRM products

crm.products.bulk.archive

Archives (is_archived: true) or unarchives (false) up to 500 products at once. Ids that do not exist are skipped and counted in missing, and products already in that state are left as they are (unchanged), the same as the bulk delete. Requires manage_products. Bulk: outside the screen it requires a dry run (which lists the products that change and flags unknown ids and the ones that would not change) and a confirm_token.

Needs confirmation: first dry_run: true (preview and confirm_token, valid 10 minutes and for one run), then the same body with confirm_token. In a few operations only with certain data: the description says when. Why and how: Dry run and confirm_token.

Scope

crm:write

Permission

Edit in the module · CRM action: manage_products

MCP tool

crm_products_bulk_archiveOn the full surface; on the compact one, mb_execute_operation with id: "crm.products.bulk.archive".

Declared cost: up to 0 reads and 500 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/crm/products/bulk/archive" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_ids": [
    "PRODUCT_ID"
  ],
  "is_archived": true,
  "dry_run": true
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/crm/products/bulk/archive" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_ids": [
    "PRODUCT_ID"
  ],
  "is_archived": true,
  "dry_run": true
}'

Delete many CRM products

crm.products.bulk.delete

Deletes up to 500 products; each one goes to the 30-day trash and can be restored individually with platform.trash.restore. Unknown ids are skipped: deleted counts what was deleted and missing what did not exist. Deal quotes keep their own copy of the lines. Requires manage_products. Outside the screen it requires a dry run and a confirm_token.

Needs confirmation: first dry_run: true (preview and confirm_token, valid 10 minutes and for one run), then the same body with confirm_token. In a few operations only with certain data: the description says when. Why and how: Dry run and confirm_token.

Scope

crm:write and “Allow deletions” (crm:delete in OAuth)

Permission

Edit in the module · CRM action: manage_products

MCP tool

crm_products_bulk_deleteOn the full surface; on the compact one, mb_execute_operation with id: "crm.products.bulk.delete".

Declared cost: up to 500 reads and 1000 writes per call (they count against the daily quota).

Parameters

Response

Errors

Example

curl -X POST "https://api.mb-suite.com/v1/crm/products/bulk/delete" \
  -H "Authorization: Bearer $MB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_ids": [
    "PRODUCT_ID"
  ],
  "dry_run": true
}'

Try it with your test API key

With a test API key the request always goes to your practice organization: example data you can reset.

curl -X POST "https://api.mb-suite.com/v1/crm/products/bulk/delete" \
  -H "Authorization: Bearer $MB_TEST_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "product_ids": [
    "PRODUCT_ID"
  ],
  "dry_run": true
}'