Endpoint to create a loot box

post/v2/admin/loot-boxes

Request

Base URL
https://loyalty.headliner.page/partner-api
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/hang/apis/hang-partner-api-params-in-formdata/docs/v2/admin/loot-boxes/post.ts
A function with typed inputs. Its response is checked against the schema.

descriptionstring required

Description of the Lootbox object.

namestring required

Name/title of the Lootbox object.

sponsor_namestring

Lootbox sponsor name.

sponsor_descriptionstring

Lootbox sponsor description.

recurring_interval_minutesnumber

Interval indicating how often a Lootbox can be granted.

image_box_together_urlstring

URL of the combined Lootbox image.

background_gradient_start_colorstring

Hexadecimal color value for the start of the gradient.

background_gradient_stop_colorstring

Hexadecimal color value for the end of the gradient.

reward_sequence_animation_type'SHUFFLE' | 'VIDEO'

Animation type dictating how a rewarded Lootbox is presented.

is_sign_up_rewardboolean

Boolean flag indicating if the Lootbox should be rewarded at signup.

Successful response

loot_boxobject required

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