POST /v4/product/descriptions/update
(Last updated: 20/12/2024)
Access to this feature is restricted and depends on your subscription type.
This endpoint allows for updating an existing product description.
Request
Method
POST
URL
https://api.medipim.be/v4/product/descriptions/update
Headers
Body
-
product: one of the following (required)- Medipim product ID (string)
- Key value array containing the identifier field and value (array)
id: Medipim description ID (integer, required)-
description:targetGroups[]: List of target groups (string[], required)locales[]: List of locales (string[], required)type: Type of the description (string, required)content[]: List of localized content; We allow the content to contain html but we don't allow every tag.
TIP
Make sure the amount of localized content matches the provided locales (or locales already set on the description).
Response
Body
-
description:id: Medipim ID of the description (integer)locales[]: List of supported locales (string[])targetGroups[]: List of associated target groups (string[])type: Type of the description (string)content.{...}: List of content (string, localized)-
meta:createdAt: When the description was created on Medipim (unix timestamp)updatedAt: when the description information was last updated (unix timestamp)