Bans

get
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Query parameters
ban_typestring · enumOptionalPossible values:
ban_type_valuestringOptional
reasonstringOptional
limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816
beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816
ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses
200

OK

application/json
get
/v1/stores/{storeId}/bans
post
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Body
reasonnull | stringOptional
identitiesnull | arrayOptional
expires_atnull | stringOptional
Responses
post
/v1/stores/{storeId}/bans
get
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
banIdstring · flake-idRequiredExample: 411486491630370816
Responses
200

OK

application/json
get
/v1/stores/{storeId}/bans/{banId}
delete
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
banIdstring · flake-idRequiredExample: 411486491630370816
Responses
delete
/v1/stores/{storeId}/bans/{banId}

No content

patch
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
banIdstring · flake-idRequiredExample: 411486491630370816
Body
reasonnull | stringOptional
identitiesnull | arrayOptional
expires_atnull | stringOptional
Responses
200

OK

application/json
patch
/v1/stores/{storeId}/bans/{banId}
post
Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequiredExample: 411486491630370816
Body
Responses
200

OK

application/json
post
/v1/stores/{storeId}/bans/check

Last updated

Was this helpful?