Skip to main content

Edit an allow list

Once you have created a listing with either an ALLOW_LIST or LARGE_ALLOW_LIST type, you may want to change who is eligible by editing these lists.

Edit an allow list using the dedicated allow-list endpoint

The best way to edit an allow list is to use the dedicated allow-list endpoint. This supports both ALLOW_LIST and LARGE_ALLOW_LIST policy types.

Issue a request to add/remove entries from the allow list:

POST https://admin-api.phosphor.xyz/v1/listings/{listing_id}/allow-list
Example payload
{
"action": "ADD",
"eth_addresses": ["0x1111111111111111111111111111111111111111"],
"email_addresses": ["aaa@aaa.com", "bbb@bbb.com"]
}

Edit an allow list for an ALLOW_LIST listing

warning

This method is deprecated and you should prefer using the dedicated endpoint.

You can issue a PATCH request to change the addresses. Note that this will replace all existing addresses, so you must use caution to ensure you do not accidentally delete addresses.

PATCH https://admin-api.phosphor.xyz/v1/listings/{listing_id}
Example payload
{
"policy": {
"type": "ALLOW_LIST",
"eth_addresses": ["0x1111111111111111111111111111111111111111"],
"email_addresses": ["aaa@aaa.com", "bbb@bbb.com"]
}
}

Note you are limited to 1000 entries in the eth_addresses and email_addresses list. If you need more, use the LARGE_ALLOW_LIST type instead.