---
title: "Handle user suspension status"
method: POST
path: "/v2/users/{id}/suspension"
tags: ["Users"]
---

# Handle user suspension status

`POST /v2/users/{id}/suspension`

## Request

- Base URL: `https://developers.brandtrack.ai/api.brandtrack.fm`
- URL: `https://developers.brandtrack.ai/api.brandtrack.fm/v2/users/{id}/suspension`
- Auth: API key in header `x-customer-api-key`
- TypeScript: <https://skmtc.dev/brandtrack/apis/brandtrack-api-documentation/docs/v2/users/:id/suspension/post.ts> (a function with typed inputs; its response is checked against the schema)

By providing the bool value, you can set or unset the suspension status for a user.

## Headers

- `x-customer-api-key` string

## Request body

- object
  - `suspended` boolean, required

## Response `200`

Success

- object
  - `id` integer
  - `uuid` string
  - `email` string
  - `firstname` string
  - `lastname` string
  - `phone_number` string
  - `country` string
  - `role` string
  - `business_category_id` integer
  - `flags` unknown[]
    - unknown
  - `suspended` boolean
  - `created_at` string

## Other responses

- `404`: Wrong ID
- `409`: Suspension issue

---

[API](https://skmtc.dev/brandtrack/apis/brandtrack-api-documentation.md) - [All operations](https://skmtc.dev/brandtrack/apis/brandtrack-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/brandtrack/apis/brandtrack-api-documentation/revisions/a2c747489f3a?raw)