Update a prescription product

Update (some) details for a product by its unique ID. Only updated fields need to be sent.

PUT /api/v1/products/prescription/{product_id}

Update a prescription product

cURL

curl --request PUT \
  --url https://api.byblend.com/api/v1/products/prescription/{product_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Mupirocin",
  "sku": "MY-SKU_1234567890",
  "description": "A topical cream that is used to treat skin infections.",
  "product_code": "SUPERSPRAY15"
}
'

200

{
  "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
  "created_at": "2025-03-15T12:00:00Z",
  "updated_at": "2025-03-15T12:00:00Z",
  "sku": "1234567890",
  "name": "Mupirocin",
  "description": "A topical cream that is used to treat skin infections.",
  "product_code": "SUPERSPRAY15",
  "form": "cream",
  "is_active": true,
  "label_orientation": "portrait",
  "strength": "1%"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

prescription product ID · string<uuid> · required

Unique (UUID) identifier for the prescription product

Example:

"98cae3a3-996c-4bf5-9143-0ab6d98bc1d0"

Body

application/json

name · string

Name of the product

Example:

"Mupirocin"

sku · string

External SKU of the product; can be referenced in orders

Example:

"MY-SKU_1234567890"

description · string

Description of the product

Example:

"A topical cream that is used to treat skin infections."

product_code · string

Customer code for the product (for use in electronic prescription references).

Example:

"SUPERSPRAY15"

Response

200 - application/json

Prescription product updated successfully

id · string<uuid>

Unique identifier

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

created_at · string<date-time>

Date and time of creation

Example:

"2025-03-15T12:00:00Z"

updated_at · string<date-time>

Date and time of last update

Example:

"2025-03-15T12:00:00Z"

sku · string

Unique inventory identifier for the product

Example:

"1234567890"

name · string

Example:

"Mupirocin"

description · string

Example:

"A topical cream that is used to treat skin infections."

product_code · string

Customer reference for the product for use in electronic prescriptions.

Example:

"SUPERSPRAY15"

form · string

Optional form of the product for customer use, if desired.

Example:

"cream"

is_active · boolean

Whether the product is currently active for purchase or prescription

Example:

true

label_orientation · string

Orientation of the printed product label, either portrait or landscape.

Example:

"portrait"

strength · string

Optional strength of the product for customer use, if desired.

Example:

"1%"