/updateWhitelist
Base URL: https://winter-api.usewinter.com
Update a project's whitelist info
🚨Note! If you update the whitelist addresses, it overwrites all previous addresses
Things you can do:
Turn whitelist on/off for a project
Add in whitelisted addresses
Choose either a standard or Merkle Tree whitelist
Update a project you've already created.
POST
/updateWhitelist
Authenticate with basic auth where the username is your API key, e.g.
curl -X POST https://winter-api.usewinter.com/updateWhitelist -u sk_live_abcd=:
await axios.post(url,{ BODY }, { auth: { username: 'sk_live_abcd=' }})
Request Body
email*
String
projectId*
Number
*
String
You need at least 1 param from /updateWhitelist to update in this request.
whitelistedAddresses
String
An array of whitelist strings (e.g. ['0x123','0x456','0x789']). Note, adding/updating new whitelistedAddresses DELETES all previously whitelisted addresses. Make sure you add in ALL whitelistedAddresses you need
whitelistStatus
Boolean
true
for whitelist on, false
for whitelist off (public mint). This also turns off or on the required address field. For example when the whitelist is turned on the required address field is turned on which takes away Winter's custodial wallet option in the checkout and vice versa.
whitelistType
String
merkle
or naked
. Merkle is using a merkle proof (and will return a root hash for you to check against) and a naked whitelist is you're checking raw addresses in smart contract
sandbox
Boolean
true
if you want to update a project in sandbox. false
if you want to update a live project!
Defaults to false
.
Last updated