GuidesAPI EndpointsChangelog
API Endpoints

Create Product

post
https://cf-blast.livelikecdn.com/api/v1/applications//products/

Creates a product in a reward store. It is always created in the draft state, so it is not visible to members until you publish it. Variants, which carry the price and stock, are added afterwards through the nested variants endpoint, and a product can't be published until it has at least one. Requires a producer access token for the application.

Send JSON, or multipart/form-data when you upload product images.

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 the product belongs to.

Body Params
uuid
required

The reward store this product belongs to. It must be an active store in this application. Write-only.

string
required
length ≤ 255

Name of the product. Max 255 characters.

string | null
enum

The kind of product. Optional here, but required before the product can be published.

string | null
enum

The third party that redeems and fulfils the product. Must be konekt when product_type is konekt, and must be empty for every other product_type. Leave it out when you fulfil the product yourself.

Allowed:
string
enum
Defaults to reward_item

How members pay for the product. reward_item debits the member's reward item balance. cash means money is collected by an external provider and no reward item is debited.

Allowed:
string

Description of the product, as plain text.

uuid | null

The reward item that variant prices are denominated in. It must be one of the reward items attached to the product's store. Required before the product can be published.

redemption_rules
object

Limits on redemption. No other keys are accepted.

gating_profile_group_ids
array of uuids

Profile groups whose members are the only ones who can redeem the product. Each group must belong to this application.

gating_profile_group_ids
category_ids
array of objects

Categories to list the product under. Each category must belong to this product's store and be published.

category_ids
sponsor_ids
array of uuids

Sponsors to attach. Each sponsor must belong to this application.

sponsor_ids
date-time

When the product becomes available. Can't be in the past.

date-time

When the product stops being available. Must be in the future and not before start_at.

redemption_success_message
object

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

redemption_failure_message
object

Message shown to the member 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

Key and value pairs. Both key and value are required on every item.

attributes
image
array of objects

Product images. Upload files with multipart/form-data, using the field names image[0]image, image[0]display_order, image[1]image and so on. Accepts JPG, PNG, GIF, WEBP and GLB files, up to 3 MB each by default. If display_order is omitted, upload order is used. At least one image is required before the product can be published.

image
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

401

Missing or invalid access token.

403

The token is not a producer token for this application.

404

No active application with this client ID.

Updated 19 days ago

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

Updated 19 days ago