Sign in

v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB
Products

Update Product

Updates the specified product by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Updates never re-run HSA/FSA eligibility determination — eligibility is set when the product is created and only changes through review. Passing categories replaces the product's existing categories (an empty array removes them all). A product.updated event is sent to your configured webhook endpoints on success.

patch/v1/products/{id}

Path parameters

idstring required
Example:fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Request body

Example request

{
  "product": {
    "name": "Example",
    "description": "Premium SPF 50 mineral sunscreen",
    "upc_code": "example_value",
    "gtin": "example_value",
    "reference_gtin": "example_value",
    "url": "https://example.com",
    "active": false,
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    }
  }
}

Response

An envelope wrapping a single product object.

Example response

{
  "product": {
    "product_id": "fprod_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "owner_partner_id": "facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
    "name": "Example",
    "description": "Premium SPF 50 mineral sunscreen",
    "created_at": "2026-06-15T14:30:00Z",
    "visit_type": "cbtSleep",
    "active": false,
    "hsa_fsa_eligibility": "not_eligible",
    "test_mode": false,
    "metadata": {
      "order_id": "8842",
      "channel": "shopify"
    },
    "url": "https://example.com",
    "client_reference_id": "obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA"
  }
}