---
title: "Ban user from token"
method: POST
path: "/v1/tokens/{tokenName}/bans"
tags: ["Token Bans"]
---

# Ban user from token

`POST /v1/tokens/{tokenName}/bans`

## Request

- Base URL: `https://lpad-backend.stage.defi.ovh.gala.com`
- URL: `https://lpad-backend.stage.defi.ovh.gala.com/v1/tokens/{tokenName}/bans`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/gala/apis/launchpad-backend-api/docs/v1/tokens/:tokenName/bans/post.ts> (a function with typed inputs; its response is checked against the schema)

Ban user from token

## Path parameters

- `tokenName` string, required

## Request body

- CreateBanDto
  - `durationSeconds` number
  - `reason` string
  - `userAddress` string, gala-chain-address, required

## Response `201`

Created ban record.

- object
  - `error` false, required: Successful response marker.
  - `message` string, required: Response message.
  - `status` number, required: HTTP status code.
  - `data` BanResponseDto, required
    - `bannedBy` string, required
    - `createdAt` string, date-time, required
    - `expiresAt` string, date-time, nullable, required
    - `id` number, required
    - `isPermanent` boolean, required
    - `reason` string, nullable, required
    - `tokenName` string, nullable, required
    - `user` BannedUserProfileResponseDto
      - `bio` string, nullable
      - `createdAt` string, date-time
      - `engagementBadge` union
        - 'SPARK' | 'GATHERING' | 'CROWD' | 'MOVEMENT'
        - unknown
      - `fullName` string, nullable, required
      - `launchBadge` union
        - 'ONE_HIT_WONDER' | 'TOKEN_CRAFTER' | 'CRYPTO_SAVVY' | 'CRYPTO_PRO' | 'MIDAS_TOUCH'
        - unknown
      - `profileImage` string, nullable, required
      - `successBadge` union
        - '250k' | '1M' | '10M+'
        - unknown
      - `volumeBadge` union
        - '1k' | '10k' | '100k' | '1M+'
        - unknown
    - `userAddress` string, required

## Other responses

- `400`: Invalid user address
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Token not found
- `default`: Shared error envelope for token ban creation failures.

---

[API](https://skmtc.dev/gala/apis/launchpad-backend-api.md) - [All operations](https://skmtc.dev/gala/apis/launchpad-backend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gala/apis/launchpad-backend-api/revisions/74545971be2b?raw)
