HIPE icon

HIPE

Interact with HIPE API

article → Update

AI-generated

Summary

Update properties of an existing article specified by its Article ID.

Inputs

  • Article ID (required) — ID of the article to update.
  • Update Fields — Fields to update on the article, including briefElementId, code, companyId, createdAt, createdById, currencyId, customFields (JSON object), description, enabled, externalId, name, previewId, price, quantity, stocked, and unit.

Output shape

the updated article object as returned from the API, containing the new values

Requires the Article ID input; fields under Update Fields are optional and only provided fields are updated.

Examples

Example 1: Update an article's name and price.

Provide the article's ID, and under Update Fields set the desired name and price values.

Links

Discussion