Update Product

Updates a product. Send only the fields you want to change. Requires a producer access token for the application.

A published product can't be edited: unpublish it first, then edit, then publish it again. The array fields category_ids, sponsor_ids, gating_profile_group_ids, attributes and image are full replacements. Send the complete list, and send an empty list to clear them. Omitting a field leaves it unchanged. Once a product has left the draft state it must keep at least one image.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The client ID of the application.

uuid
required

The ID of the product.

Body Params
string
length ≤ 255

Name of the product. Max 255 characters.

string | null
enum

The kind of product. Switching to a single-variant type fails if the product has more than one active variant.

string | null
enum

Must be konekt when product_type is konekt, and empty for every other type.

Allowed:
string
enum

How members pay for the product.

Allowed:
string

Description of the product, as plain text.

uuid | null

Must be one of the reward items attached to the product's store.

redemption_rules
object

Limits on redemption. Only max_redemptions_per_user and max_redemption_days are accepted, and the days value needs the per-user cap.

gating_profile_group_ids
array of uuids

Full replace. Profile groups that can redeem the product.

gating_profile_group_ids
category_ids
array of objects

Full replace. Each category must belong to the product's store and be published.

category_ids
sponsor_ids
array of uuids

Full replace. Sponsors to attach.

sponsor_ids
date-time

Can't be in the past.

date-time

Must be in the future and not before start_at.

redemption_success_message
object

Message shown after a successful redemption, as a JSON object such as {"title": "Success!", "message": "Your reward has been redeemed"}.

redemption_failure_message
object

Message shown when a redemption fails, as a JSON object such as {"title": "Oops!", "message": "We could not redeem your reward"}.

string

Free text, for example serialized JSON.

attributes
array of objects

Full replace. Both key and value are required on every item.

attributes
image
array of objects

Full replace. Send multipart/form-data with image[0]image, image[0]display_order and so on. Accepts JPG, PNG, GIF, WEBP and GLB, up to 3 MB each by default.

image
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json