CargoLabs Docs
Products

Update a product

Partial update. Only the fields you send are changed.

PATCH
/products/{id}

Partial update. Only the fields you send are changed.

Authorization

ApiKeyAuth
x-api-key<token>

API key from the CoverPort developer portal.

In: header

Path Parameters

id*integer
Range1 <= value

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Every field of CreateProductRequest, all optional, except agencyRootAccountID and isTestMode which cannot change.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/products/318" \  -H "Content-Type: application/json" \  -d '{    "defaultPrice": 59,    "deductible": 750  }'
{  "success": true,  "data": {    "id": 318,    "ins_product_line_product_name_customer": "Cargo Excess",    "ins_product_line_product_name_internal": "CARGO_EXCESS_2026",    "ins_product_line_product_description": "string",    "ins_product_line_product_default_price": 49,    "ins_product_line_product_insurer_name": "string",    "ins_product_line_claims_phone_number": "string",    "ins_product_line_agency_product_video_url": "string",    "ins_product_line_agency_root_accnt_id": 0,    "ins_product_line_master_policy_number": "string",    "ins_product_line_policy_number_two": "string",    "ins_product_line_deductible_dollar_amount": 0,    "ins_product_line_is_recurring": 0,    "ins_product_line_is_bundle": 0,    "ins_product_line_stripe_product_is_test_mode": 0,    "ins_product_line_stripe_product_uuid": "prod_R8kQ2mQ9Xl2Vb1",    "ins_product_line_question_set_id": 0,    "ins_product_line_mga_root_accnt_id": 0,    "ins_product_line_insurer_root_accnt_id": 0,    "ins_product_line_creation_datetime": "2019-08-24T14:15:22Z",    "ins_product_line_last_updated_datetime": "2019-08-24T14:15:22Z"  },  "message": "Product updated successfully"}

List products GET

Returns a page of product lines, newest first.

Create a bundle POST

Creates a bundle and optionally links products to it. The first id in product_ids becomes the primary product. When product_ids is non-empty, at least one of root_insurer_db_id, root_mga_db_id or root_seller_db_id is required. Unknown fields are rejected.