LIlivelike

Create Category

Creates a category inside a reward store. It is always created in the draft state, so it is not visible to members until you publish it. Requires a producer access token for the application.

The store must be an active store in this application, and it can't be changed later. The name must be unique among the store's active categories. If you leave out sequence, the category goes to the next free position. A category needs a sequence and a description before it can be published.

post/{client_id}/categories/

Request

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

Path parameters

client_idstring required

The client ID of the application.

Request body

product_store_idstring uuid required

The reward store this category belongs to. It must be an active store in this application and can't be changed later.

namestring required

Name of the category. Max 255 characters, and unique among the store's active categories.

descriptionstring

Description of the category. Required before the category can be published.

sequenceinteger nullable

Position of the category in the store, zero or higher. If omitted, it goes to the next free position. Must be unique among the store's active categories.

custom_datastring

Free text, for example serialized JSON.

Response

Created. The category is returned in the draft state.

idstring uuid
namestring
sequenceinteger nullable
statestring
is_activeboolean

Changes

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