products

Update a product

patch/v3/products/{id}

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/products/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

Product ID

Request body

namestring

Internal catalog name of the product

displayNamestring

Customer-facing display name of the product

status'ACTIVE' | 'INACTIVE'

Product status (active or inactive)

arrDefault'INCLUDE' | 'EXCLUDE' | 'UNSPECIFIED'

ARR treatment a new billing term inherits when created against this product. Omit to leave it unchanged. Applies only to billing terms created after the change.

descriptionstring

Product description

integrationItemIdstring

ERP integration item ID

erpClassIdstring

ERP class ID

Response

Product updated successfully

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

No recorded changes to this operation across all 1 revision of this API.