Create milestone level - Loyi API Reference

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Origin

string

required

The value must be one of the whitelisted domains. You can whitelist domain URLs on your Loyi dashboard.

Default:

<WHITELISTED_URL>

Example:

https://example.com

Body Params application/json

title

string

required

Title of the milestone level.

levelNumber

number

required

Level number of the milestone level.

rewards

object

required

rewardIds

array[string <uuid>]

optional

IDs of the rewards of the quest.

collectionIds

array[string <uuid>]

optional

IDs of the collections of the quest.

Example

{
    "title": "Gold Level",
    "levelNumber": 32,
    "rewards": {
        "rewardIds": [
            "123e4567-e89b-12d3-a456-426655440000"
        ],
        "collectionIds": [
            "123e4567-e89b-12d3-a456-426655440000"
        ]
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://testserver.loyi.io/public/api/leveling/milestone' \
--header 'Origin;' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "title": "Gold Level",
    "levelNumber": 32,
    "rewards": {
        "rewardIds": [
            "123e4567-e89b-12d3-a456-426655440000"
        ],
        "collectionIds": [
            "123e4567-e89b-12d3-a456-426655440000"
        ]
    }
}'

Responses

🟢201Created

application/json

Created

Body

id

string <uuid>

required

title

string

required

Title of the milestone level.

levelNumber

number

required

Level number of the milestone level.

rewards

object

required

rewards

array[null (Reward) {3}]

optional

collections

array[object (Collection) {11}]

optional

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

Example

{
    "id": "123e4567-e89b-12d3-a456-426655440000",
    "title": "Gold Level",
    "levelNumber": 10,
    "rewards": {
        "rewards": [
            {
                "id": "123e4567-e89b-12d3-a456-426655440000",
                "title": "Event Entry Pass",
                "description": "An entry pass for the event",
                "instruction": "Show this pass at the event entrance",
                "type": "EntryPass",
                "createdAt": "2022-01-01T00:00:00.000Z",
                "updatedAt": "2022-01-01T00:00:00.000Z"
            }
        ],
        "collections": [
            {
                "id": "123e4567-e89b-12d3-a456-426655440000",
                "publicId": "kdPd_ntE",
                "name": "My Collection",
                "description": "A collection of rewards",
                "image": "https://example.com/image.jpg",
                "amount": 10,
                "collectible": {
                    "imagesURL": "ipfs://example",
                    "metadataURL": "ipfs://example"
                },
                "type": "oneToOne",
                "contractAddress": "0x7B5DF6F27C32cEa2CeF2c4E812c0Ff4d0515B26B",
                "createdAt": "2021-01-01T00:00:00.000Z",
                "updatedAt": "2021-01-01T00:00:00.000Z"
            }
        ]
    },
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z"
}

🟠400Bad Request

🟠401Unauthorized