Products

Update product

Update an existing product.

PATCH
/api/v1/products/{productId}
AuthorizationBearer <token>

Your API key.

In: header

Path Parameters

productIdstring

The product ID.

name?string

The name of the product.

description?string

The description of the product.

supportEmail?string

The support email for the product.

portalShow?boolean

Whether the product is shown in the portal.

portalAllowDeviceReset?boolean

Whether device resets are allowed for the product in the portal.

Response Body

application/json

curl -X PATCH "https://keyforge.dev/api/v1/products/p_123456" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "p_123456",
  "userId": "05d27bfb-61c7-45f7-9d07-09a41defc88a",
  "name": "My product",
  "description": "This is my product.",
  "supportEmail": null,
  "createdAt": "2024-05-19T04:31:03.000Z",
  "portalShow": true,
  "portalAllowDeviceReset": true,
  "hasImage": false,
  "purchaseNote": null,
  "actionButtonText": null,
  "actionButtonUrl": null
}
Empty