LIlivelike

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.

patch/{client_id}/products/{id}/

Request

  • Base URL
    https://cf-blast.livelikecdn.com/api/v1/applications
  • URL
    https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/products/{id}/
  • Auth
    API key in header Authorization

Path parameters

client_idstring required

The client ID of the application.

idstring uuid required

The ID of the product.

Request body

namestring

Name of the product. Max 255 characters.

product_type'badge' | 'multiplier' | 'flair' | 'common_code' | 'unique_code' | 'merchandise' | 'experience' | 'konekt' nullable

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

redemption_provider'konekt' nullable

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

redemption_method'reward_item' | 'cash'

How members pay for the product.

descriptionstring

Description of the product, as plain text.

reward_item_idstring uuid nullable

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

gating_profile_group_idsstring[]

Full replace. Profile groups that can redeem the product.

sponsor_idsstring[]

Full replace. Sponsors to attach.

start_atstring date-time

Can't be in the past.

expiry_atstring date-time

Must be in the future and not before start_at.

redemption_success_messageobject

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

redemption_failure_messageobject

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

custom_datastring

Free text, for example serialized JSON.

Response

OK. The updated product.

idstring uuid
namestring
state'draft' | 'published' | 'unpublished'

Changes

No recorded changes to this operation across all 1 revision of this API.