Whitelist
Export Whitelist
Exports the whitelist entries to CSV.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalpageintegerperPageintegerMust be at least 1. Must not be greater than 100.
orderColumnstring"id" | "value" | "type" | "reason" | "enabled" | "created_at"orderDirectionstring"asc" | "desc"idstringtypesarray<string>valuestringreasonstringpayment_method_idsobjectenabledbooleanactive_fromstringMust be a valid date.
active_tostringMust be a valid date. Must be a date after active_from.
created_at_fromstringMust be a valid date.
created_at_tostringMust be a valid date. Must be a date after created_at_from.
Path Parameters
shopIdRequiredintegerThe shop ID.
Get Whitelist
Retrieves the whitelist entries.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalpageintegerperPageintegerMust be at least 1. Must not be greater than 100.
orderColumnstring"id" | "value" | "type" | "reason" | "enabled" | "created_at"orderDirectionstring"asc" | "desc"idstringtypesarray<string>valuestringreasonstringpayment_method_idsobjectenabledbooleanactive_fromstringMust be a valid date.
active_tostringMust be a valid date. Must be a date after active_from.
created_at_fromstringMust be a valid date.
created_at_tostringMust be a valid date. Must be a date after created_at_from.
Path Parameters
shopIdRequiredintegerThe shop ID.
Create Whitelist Entry
Creates a new whitelist entry.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredvalueRequiredstringtypeRequiredstring"email" | "email_domain" | "discord_id" | "country_code" | "city" | "ip" | "ip_range" | "isp" | "asn" | "user_agent"reasonstringpayment_method_idsarray<string>enabledbooleanactive_fromstringMust be a valid date. Must be a date before 2038-01-19.
active_tostringMust be a valid date. Must be a date after active_from. Must be a date before 2038-01-19.
Path Parameters
shopIdRequiredintegerThe shop ID.
Get Whitelist Entry
Retrieves a specific whitelist entry.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
whitelistIdRequiredintegerThe whitelist entry ID.
Delete Whitelist Entry
Deletes a specific whitelist entry.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
whitelistIdRequiredintegerThe whitelist entry ID.
Update Whitelist Entry
Updates a specific whitelist entry.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequiredidRequiredintegervalueRequiredstringtypeRequiredstring"email" | "email_domain" | "discord_id" | "country_code" | "city" | "ip" | "ip_range" | "isp" | "asn" | "user_agent"reasonstringpayment_method_idsarray<string>enabledbooleanactive_fromstringMust be a valid date. Must be a date before 2038-01-19.
active_tostringMust be a valid date. Must be a date after active_from. Must be a date before 2038-01-19.
Path Parameters
shopIdRequiredintegerThe shop ID.
whitelistIdRequiredintegerThe whitelist entry ID.
Toggle Whitelist Entry Status
Toggles the active status of a specific whitelist entry.
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredintegerThe shop ID.
whitelistIdRequiredintegerThe whitelist entry ID.