Create New Project

Endpoint

POST /api/:partner/projects/new

When requesting this URL replace :partner with your specific partner tag, which you will receive when onboarded with Mintplex. This tag must match the one provided to you by Mintplex.

You should include an externalProjectId inside of the projectInfo object in the request body. This id should be a unique identifier for your specific service. This UID will be what you use to reference the project.

{
    headers: "Authorization <USER_ETH_ADDRESS_ALL_LOWERCASE>",
    body: {
        projectInfo: {
            // Required Fields
            externalProjectId: "UID_TO_YOUR_SYSTEM",
            
            // Optional Fields - these will be included on create, but can be updated.
            network: 'ethereum' | 'polygon',
            name: string,
            tokenSymbol: string | max: 10,
            hasMintFee: bool, // enables mint fee setting
            hasAllowListing: bool, // enables allowlist feature
            mintPrice: number | float | min: 0, // value in ETH/MATIC of per-mint cost
            supply: number | min:0, // total token supply
            hasWalletMax: bool, // enables wallet max feature
            walletMax: number, // value for wallet max feature
            tokenURI: null, // optional centralized URL that user can specify instead of IPFS
            headerMark: string, // ASCII header mark for contract
            maxMintPerTxn: number | min:0, // max mint per transaction
            website: string | null, // website for project
        }
    },
}

You will then be returned a response like

200 OK

{
    "status": true,
    "project": {
        ...all project information
    }
}

303 SEE OTHER

{
    "status": true,
    "message: "A project with this externalProjectId already exists!",
    "project": {
        ...all project information
    }
}

400 BAD

{
    "status": false,
    "message": "invalid params",
    "project": null
}