Update product

You can update products using the SDK. Here is an example of how to update a product:

import { Keyforge } from 'keyforge-js';
 
const keyforge = new Keyforge('sk_1234');
 
const product = await keyforge.products.update('p_123456', {
  name: 'New name',
  description: 'New description',
});

Parameters

Prop	Type	Default
`id?`	`string`	-
`params?`	`UpdateProductParams`	-

UpdateProductParams type

Prop	Type	Default
`name?`	`string \| undefined`	-
`description?`	`string \| undefined`	-
`supportEmail?`	`string \| undefined`	-
`portalShow?`	`boolean \| undefined`	-
`portalAllowDeviceReset?`	`boolean \| undefined`	-

Returns

Here is an example of the updated product object:

{
  "id": "p_123456",
  "userId": "05d27bfb-61c7-45f7-9d07-09a41defc88a",
  "name": "New name",
  "description": "New description",
  "supportEmail": null,
  "portalShow": true,
  "portalAllowDeviceReset": true,
  "createdAt": "2024-05-19T04:31:03.000Z"
}

Parameters

UpdateProductParams type

Returns

On this page