Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
Product

Update Product

Update a Product with the given UUID.

This endpoint updates the details of a specific Product within a specified Organization, using the Product UUID. The updated details are provided in the request body.

Note: If you have created Custom Fields for a Product, when you use this endpoint to update the Product use the customFields parameter to preserve those Custom Fields. If you omit them from the update request, they will be lost.

put/organizations/{orgId}/products/{id}

Path parameters

orgIdstring required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

idstring required

The unique identifer (UUID) of the Product to update.

Request body

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level, customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

namestring required

Descriptive name for the Product providing context and information.

codestring required

A unique short code to identify the Product. It should not contain control chracters or spaces.

Response

Returns the updated Product

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

namestring

Descriptive name for the Product providing context and information.

codestring

A unique short code to identify the Product. It should not contain control chracters or spaces.

dtCreatedstring date-time

The date and time (in ISO-8601 format) when the Product was created.

dtLastModifiedstring date-time

The date and time (in ISO-8601 format) when the Product was last modified.

createdBystring

The unique identifier (UUID) of the user who created this Product.

lastModifiedBystring

The unique identifier (UUID) of the user who last modified this Product.